Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump pdoc from 12.3.0 to 14.5.1 in /src/api/python/doc #1956

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jun 25, 2024

Bumps pdoc from 12.3.0 to 14.5.1.

Changelog

Sourced from pdoc's changelog.

2024-06-25: pdoc 14.5.1

2024-05-16: pdoc 14.5.0

2024-01-18: pdoc 14.4.0

  • Private methods can now be included in the documentation by adding @public to the docstring. This complements the existing @private annotation. (#655, @​tmeyier)
  • pdoc now correctly detects the source file for wrapped functions. (#657, @​tmeyier)
  • Fixed a bug where memory addresses were not removed from output. (#663, @​mhils)

2023-12-22: pdoc 14.3.0

  • Improve rendering of .pyi type stubs containing @typing.overload. (#652, @​mhils)
  • @property and @cached_property attributes now have a "View Source" button. (#654, @​tmeyier)

2023-12-13: pdoc 14.2.0

  • pdoc now documents PyO3 or pybind11 submodules that are not picked up by Python's builtin pkgutil module. (#633, @​mhils)
  • pdoc now supports Python 3.12's type statements and has improved TypeAlias rendering. (#651, @​mhils)
  • Imports in a TYPE_CHECKING section that reference members defined in another module's TYPE_CHECKING section now work correctly. (#649, @​mhils)
  • Add support for code-block ReST directives (#624, @​JCGoran)
  • If a variable's value meets certain entropy criteria and matches an environment variable value, pdoc will now emit a warning and display the variable's name as a placeholder instead. This heuristic is meant to prevent accidental leakage of environment secrets and can be disabled by setting PDOC_DISPLAY_ENV_VARS=1.

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
    You can disable automated security fix PRs for this repo from the Security Alerts page.

Bumps [pdoc](https://github.com/mitmproxy/pdoc) from 12.3.0 to 14.5.1.
- [Changelog](https://github.com/mitmproxy/pdoc/blob/main/CHANGELOG.md)
- [Commits](mitmproxy/pdoc@v12.3.0...v14.5.1)

---
updated-dependencies:
- dependency-name: pdoc
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot requested review from a team as code owners June 25, 2024 22:24
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jun 25, 2024
@dependabot dependabot bot temporarily deployed to pr-actions-approval June 25, 2024 22:24 Inactive
@ddelnano
Copy link
Member

Verified that the doc generation before and after is the same.

(main) $ bazel build src/api/python/doc:generate
(main) $ sha256sum bazel-bin/src/api/python/doc/py_api_docs.json
207346a8e19ef585462276cddffba139fd04877374e0a52c172b8e97887cb340  bazel-bin/src/api/python/doc/py_api_docs.json

(main) $ gh pr checkout 1956
branch 'dependabot/pip/src/api/python/doc/pdoc-14.5.1' set up to track 'origin/dependabot/pip/src/api/python/doc/pdoc-14.5.1'.
Switched to a new branch 'dependabot/pip/src/api/python/doc/pdoc-14.5.1'

(dependabot/pip/src/api/python/doc/pdoc-14.5.1) $ bazel build src/api/python/doc:generate
(dependabot/pip/src/api/python/doc/pdoc-14.5.1) $ sha256sum bazel-bin/src/api/python/doc/py_api_docs.json
207346a8e19ef585462276cddffba139fd04877374e0a52c172b8e97887cb340  bazel-bin/src/api/python/doc/py_api_docs.json

@ddelnano
Copy link
Member

@pixie-io/third-party-reviewers this is ready for review. I believe the dependency-review action is a false positive.

@vihangm vihangm merged commit 730d051 into main Jul 10, 2024
19 of 20 checks passed
@vihangm vihangm deleted the dependabot/pip/src/api/python/doc/pdoc-14.5.1 branch July 10, 2024 20:46
ddelnano pushed a commit to ddelnano/pixie that referenced this pull request Sep 23, 2024
Summary: Bumps [pdoc](https://github.com/mitmproxy/pdoc) from 12.3.0 to 14.5.1.

Relevant Issues: CVE-2024-38526

Type of change: /kind cve

Test Plan: python docgen still works.

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
GitOrigin-RevId: 730d051
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants