-
Notifications
You must be signed in to change notification settings - Fork 223
chore(deps-dev): bump pdoc from 14.6.0 to 15.0.1 #1040
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disclaimer: Experimental PR review
PR Summary
Updates the pdoc dependency from 14.4.0 to 15.0.1 in pyproject.toml, with significant changes to documentation generation.
- Removes support for Python 3.8 (not an issue since package requires Python >=3.9)
- Changes how inherited members are documented - now hidden by default if base class is not documented
- Adds support for Python 3.13 @deprecated decorators with visual emphasis
- Improves mocking of sys.stdin/stdout/stderr to fix runtime errors
- Includes security fixes for pdoc's math mode functionality
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
8bd929f to
f322a7d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disclaimer: Experimental PR review
PR Summary
This PR updates the pdoc dependency version constraint from '^14.4.0' to '>=14.4,<16.0'. Here are the key changes since the last review:
- Adds Mermaid.js v11 support for documentation diagrams
- Improves handling of OpenSSL 3.2.0 error messages for HTTP proxy configuration
- Fixes bug where entire modules would be excluded by
--no-include-undocumentedflag - Fixes crash when importing .pyi files and improves TypedDict subclass rendering
- Removes polyfill.io scripts from math mode documentation for security
The changes are focused on documentation generation improvements and bug fixes while maintaining backward compatibility.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
f322a7d to
eff238c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disclaimer: Experimental PR review
PR Summary
Updates the pdoc dependency version constraint in pyproject.toml with additional security and functionality improvements since previous reviews.
- Removes scripts from polyfill.io in math mode documentation for enhanced security (CVE-2024-2965)
- Updates Mermaid.js CDN location from v10 to v11 for improved diagram rendering
- Fixes API documentation issues with unittest.mock module
- Corrects link to Google usage example in documentation
The changes focus on security hardening and documentation improvements while maintaining the same core functionality.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
eff238c to
a413943
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disclaimer: Experimental PR review
PR Summary
Updates the pdoc dependency version constraint in pyproject.toml with additional security and functionality improvements since previous reviews.
- Adds support for string values as
max_shard_sizeinsplit_state_dict_into_shards_factory(e.g. "5MB") - Improves import time performance on Windows systems
- Reduces verbosity of "Waiting for suitable server" log message from info to debug level
- Fixes bug where pdoc would crash when importing .pyi files
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
a413943 to
9c7d8f8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disclaimer: Experimental PR review
PR Summary
Based on the changes since the last review, here is my summary of the pdoc dependency update:
Updates pdoc dependency version constraint in pyproject.toml with additional security and documentation improvements.
- Fixes text_generation output bug in documentation generation
- Improves custom.css docstring examples for better documentation styling
- Updates dependencies for enhanced security and stability
- Removes redundant code examples and improves documentation clarity
The changes continue to focus on documentation quality and security while maintaining core functionality.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
Bumps [pdoc](https://github.com/mitmproxy/pdoc) from 14.6.0 to 15.0.1. - [Changelog](https://github.com/mitmproxy/pdoc/blob/main/CHANGELOG.md) - [Commits](mitmproxy/pdoc@v14.6.0...v15.0.1) --- updated-dependencies: - dependency-name: pdoc dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
9c7d8f8 to
a8a54ce
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disclaimer: Experimental PR review
PR Summary
Based on the recent changes, here is my summary of the pdoc dependency update:
Updates pdoc dependency version constraint in pyproject.toml with additional security and documentation improvements.
- Adds chunking_strategy support for polling helpers in API documentation
- Fixes erroneous thread create argument handling in documentation generation
- Removes polyfill.io scripts from math mode for enhanced security (CVE-2024-2965)
- Improves API documentation for unittest.mock module
The changes focus on API documentation accuracy and security hardening while maintaining core functionality.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
|
Superseded by #1168. |
Bumps pdoc from 14.6.0 to 15.0.1.
Changelog
Sourced from pdoc's changelog.
Commits
485d9fapdoc 15.0.1a03feabBump autofix-ci/action in the dependencies group (#764)431849fUpdate CHANGELOG.mda939ab1Update CDN location of mermaid from v10 to v11 (#763)c5c6feadocs: correct link to Google usage example (#760)d44d4f8fix(#753): API documentation forunittest.mock(#754)5a8fdc1Update CHANGELOG.md738f791pdoc 15.0.0f481381Update CHANGELOG.mdba6e199improve io mocking (#751)You can trigger a rebase of this PR by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot mergewill merge this PR after your CI passes on it@dependabot squash and mergewill squash and merge this PR after your CI passes on it@dependabot cancel mergewill cancel a previously requested merge and block automerging@dependabot reopenwill reopen this PR if it is closed@dependabot closewill close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill 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 versionwill 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 dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)