Skip to content
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

fix: rdoc generation excluding MODEL_CLASS (closes #317) #318

Merged
merged 2 commits into from
Dec 17, 2024

Conversation

Justintime50
Copy link
Member

@Justintime50 Justintime50 commented Dec 17, 2024

Description

Rdoc was getting confused about the constant taking precedence over the class name for classes containing a MODEL_CLASS, this change tells rdoc not to document the constant which wasn't needed to begin with which removes the unnecessary MODEL_CLASS doc generation and cleans up the resulting output.

Also bumps rdoc to use newer stylized docs output.

Closes #317

Testing

See new output:

Screenshot 2024-12-17 at 11 13 08 AM

Pull Request Type

Please select the option(s) that are relevant to this PR.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Improvement (fixing a typo, updating readme, renaming a variable name, etc)

@Justintime50 Justintime50 requested a review from a team as a code owner December 17, 2024 18:15
Copy link
Member

@nwithan8 nwithan8 left a comment

Choose a reason for hiding this comment

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

Also needs cleanup under the EasyPost - > Models section

@Justintime50
Copy link
Member Author

Justintime50 commented Dec 17, 2024

Also needs cleanup under the EasyPost - > Models section

Yeah, this fixes that. Rdoc was most certainly confused about the same named files in two separate dirs. Removing the MODEL_CLASS const from docs makes everything right in the world.

Screenshot 2024-12-17 at 12 05 31 PM

@nwithan8 nwithan8 self-requested a review December 17, 2024 19:43
@Justintime50 Justintime50 merged commit 1dd7074 into master Dec 17, 2024
8 checks passed
@Justintime50 Justintime50 deleted the fix_rdoc_generation branch December 17, 2024 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Library Docs are broken
3 participants