Skip to content

docs: add code block syntax to docstrings #9749

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 29, 2025
Merged

docs: add code block syntax to docstrings #9749

merged 1 commit into from
Aug 29, 2025

Conversation

dfokina
Copy link
Contributor

@dfokina dfokina commented Aug 29, 2025

Proposed Changes:

Adding code block syntax to docstrings, as this is causing documentation workflow to fail.

How did you test it?

Notes for the reviewer

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
  • I added unit tests and updated the docstrings
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@dfokina dfokina requested a review from a team as a code owner August 29, 2025 10:22
@dfokina dfokina added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Aug 29, 2025
@dfokina dfokina requested review from anakin87 and removed request for a team August 29, 2025 10:22
@github-actions github-actions bot added the type:documentation Improvements on the docs label Aug 29, 2025
anakin87
anakin87 approved these changes Aug 29, 2025
View reviewed changes
Copy link
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

👍

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 17321258267

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.098%
Totals Coverage Status
Change from base Build 17321256910: 0.0%
Covered Lines: 12925
Relevant Lines: 14034
💛 - Coveralls

@dfokina dfokina enabled auto-merge (squash) August 29, 2025 10:27
@dfokina dfokina merged commit 477188d into main Aug 29, 2025
22 checks passed
@dfokina dfokina deleted the fix_agent_pydoc branch August 29, 2025 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anakin87 anakin87 anakin87 approved these changes

Assignees
No one assigned
Labels
ignore-for-release-notes PRs with this flag won't be included in the release notes. type:documentation Improvements on the docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dfokina @coveralls @anakin87