Skip to content

Generated docs for missing docstrings #241

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
Jan 31, 2025
Merged

Generated docs for missing docstrings #241

merged 1 commit into from
Jan 31, 2025

Conversation

jemeza-codegen
Copy link
Contributor

Motivation

Many attributes are missing docstrings

Content

Testing

Please check the following before marking your PR as ready for review

  • I have added tests for my changes
  • I have updated the documentation or added new documentation as needed

@jemeza-codegen jemeza-codegen requested review from codegen-team and a team as code owners January 31, 2025 22:51
@jemeza-codegen jemeza-codegen requested review from bagel897 and removed request for a team January 31, 2025 22:51
@codecov Codecov
Copy link

codecov bot commented Jan 31, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 93.18182% with 3 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
...dk/code_generation/doc_utils/generate_docs_json.py 78.57% 3 Missing ⚠️
Additional details and impacted files

@jemeza-codegen jemeza-codegen merged commit 373e7a8 into develop Jan 31, 2025
20 checks passed
@jemeza-codegen jemeza-codegen deleted the attr-docs branch January 31, 2025 23:43
jayhack pushed a commit that referenced this pull request Feb 9, 2025
@jemeza-codegen
Generated docs for missing docstrings (#241)
f06005e 
# Motivation
Many attributes are missing docstrings

# Content
<!-- Please include a summary of the change -->
# Testing
<!-- How was the change tested? -->
# Please check the following before marking your PR as ready for review

- [x] I have added tests for my changes
- [x] I have updated the documentation or added new documentation as
needed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bagel897 bagel897 bagel897 approved these changes

@codegen-team codegen-team Awaiting requested review from codegen-team codegen-team is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jemeza-codegen @bagel897