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.

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

[Bug]: Library Docs are broken #317

Closed
spuder opened this issue Dec 17, 2024 · 2 comments · Fixed by #318
Closed

[Bug]: Library Docs are broken #317

spuder opened this issue Dec 17, 2024 · 2 comments · Fixed by #318
Labels
triage Issue is being researched

Comments

@spuder
Copy link

spuder commented Dec 17, 2024

Software Version

6.4.1

Language Version

6.4.1

Operating System

OSX

What happened?

If you click on the library documentation, it takes you to a page with broken information. Notice how it just says "module class" over and over. None of the classes have any docs

Screenshot 2024-12-16 at 22 46 28

https://easypost.github.io/easypost-ruby/index.html

What was expected?

The documentation should show documentation.

Click here to see for yourself: https://easypost.github.io/easypost-ruby/index.html

Sample Code

No response

Relevant logs

No response
@spuder spuder added the triage Issue is being researched label Dec 17, 2024
@nwithan8
Copy link
Contributor

Thank you for reporting this, we will investigate the issue regarding the excess "MODEL_CLASS" entries. In the meantime, all the normal documentation is available by expanding the "EasyPost" section at the top of the sidebar:

image

Justintime50 added a commit that referenced this issue Dec 17, 2024
@Justintime50
fix: rdoc generation excluding MODEL_CLASS (closes #317)
a21971d
@Justintime50 Justintime50 mentioned this issue Dec 17, 2024
Merged
4 tasks
Justintime50 added a commit that referenced this issue Dec 17, 2024
@Justintime50
Merge pull request #318 from EasyPost/fix_rdoc_generation
1dd7074 
fix: rdoc generation excluding MODEL_CLASS (closes #317)
@Justintime50
Copy link
Member

Justintime50 commented Dec 17, 2024 •
edited
Loading

If you revisit the library docs, they should be corrected (all the extra MODEL_CLASS definitions should be removed.) Thanks for reporting this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
triage Issue is being researched
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: rdoc generation excluding MODEL_CLASS (closes #317) EasyPost/easypost-ruby
3 participants
@spuder @nwithan8 @Justintime50