docs: improve documentation for clarity #37
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ ❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 1 file with indirect coverage changes 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
PR Overview
This PR improves documentation clarity across multiple modules by enhancing docstrings and inline comments. The changes update and standardize documentation in modules related to element finding, connection management, browser process management, and page interactions to ensure consistency and better developer guidance.
- Updated docstrings in pydoll/mixins/find_elements.py, connection/managers.py, connection/connection.py to clearly describe method behaviors.
- Enhanced and translated inline comments in pydoll/browser/managers.py, element.py, page.py, and chrome.py for consistent English language usage.
- Improved detail on parameters, return types, and raised exceptions across the codebase.
Reviewed Changes
| File | Description |
|---|---|
| pydoll/mixins/find_elements.py | Enhanced docstrings for element finding methods with additional details. |
| pydoll/connection/managers.py | Added comprehensive English docstrings; note minor untranslated inline comment remains. |
| pydoll/connection/connection.py | Updated docstrings for connection methods and internal functions for clarity. |
| pydoll/browser/managers.py | Improved documentation for proxy, browser process, and temp directory management. |
| pydoll/element.py | Updated and standardized docstrings for web element interactions. |
| pydoll/browser/page.py | Enhanced documentation for page operations such as navigation, cookie, and event handling. |
| pydoll/browser/chrome.py | Added detailed docstrings describing Chrome-specific implementations. |
| pydoll/browser/base.py | Standardized docstrings in base browser functions for consistency. |
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
pydoll/connection/managers.py:227
- Consider updating the inline comment 'Mantém tamanho máximo' to 'Maintains maximum size' for consistency with the rest of the English documentation.
self.network_logs = self.network_logs[-10000:] # Mantém tamanho máximo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.