Skip to content

Dv/skruk/docstring cleanup#21

Merged
sebastiankruk merged 15 commits intodynatrace-oss:release/0.9.2from
sebastiankruk:dv/skruk/docstring-cleanup
Nov 6, 2025
Merged

Dv/skruk/docstring cleanup#21
sebastiankruk merged 15 commits intodynatrace-oss:release/0.9.2from
sebastiankruk:dv/skruk/docstring-cleanup

Conversation

@sebastiankruk
Copy link
Collaborator

No description provided.

@sebastiankruk sebastiankruk added this to the Version 0.9.2 milestone Nov 6, 2025
@sebastiankruk sebastiankruk self-assigned this Nov 6, 2025
@sebastiankruk sebastiankruk added the documentation Improvements or additions to documentation label Nov 6, 2025
@sebastiankruk sebastiankruk requested a review from Copilot November 6, 2025 07:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR focuses on standardizing docstring formatting across the codebase to improve consistency and readability. The changes convert multi-line docstrings to single-line format where appropriate, correct spelling errors, and improve code style compliance.

  • Converts multi-line docstrings to single-line format following PEP 257 conventions
  • Corrects spelling errors in documentation and error messages
  • Improves code readability by fixing string concatenation and formatting issues

Reviewed Changes

Copilot reviewed 48 out of 49 changed files in this pull request and generated no comments.

Show a summary per file
File Description
test/plugins/test_1_validate.py Fixed spelling error in docstring and improved code style with "not in" operator
test/core/test_documentation.py Reformatted multi-line docstrings for better readability
test/core/test_config.py Corrected spelling error in assertion message
test/_utils.py Standardized docstring format to single-line where appropriate and added missing parameter documentation
test/_mocks/telemetry.py Converted multi-line docstrings to single-line format and corrected parameter documentation
test/init.py Standardized docstring format to single-line
src/dtagent/version.py Converted multi-line docstring to single-line format
src/dtagent/util.py Standardized docstring formats, added raw string prefix for escape sequences, and improved parameter documentation formatting
src/dtagent/plugins/*.py Converted multi-line docstrings to single-line format across multiple plugin files
src/dtagent/plugins/.config/.yml Reordered event_timestamps entries for consistency
src/dtagent/plugins/resource_monitors.py Added import for EVENT_TIMESTAMP_KEYS_PAYLOAD_NAME and improved docstring consistency
src/dtagent/otel/*.py Standardized docstring formats and improved multi-line string formatting
src/dtagent/connector.py Converted multi-line docstrings to single-line format
src/dtagent/config.py Improved multi-line parameter documentation formatting
src/dtagent/agent.py Converted multi-line docstrings to single-line format
src/dtagent/init.py Standardized docstring format to single-line
src/build/*.py Converted multi-line docstrings to single-line format and improved string formatting
src/init.py Added module docstring
setup.cfg Added flake8 configuration for docstring conventions
.vscode/settings.json Added new words to spell checker dictionary
.pylintrc Removed C0111 (missing-docstring checks) from disabled rules

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sebastiankruk sebastiankruk merged commit 3e7e603 into dynatrace-oss:release/0.9.2 Nov 6, 2025
6 checks passed
@sebastiankruk sebastiankruk deleted the dv/skruk/docstring-cleanup branch November 6, 2025 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants