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

ActiveStorage::Blob and others excluded from Docs #36321

Closed
mvastola opened this issue May 21, 2019 · 6 comments · Fixed by #36997
Closed

ActiveStorage::Blob and others excluded from Docs #36321

mvastola opened this issue May 21, 2019 · 6 comments · Fixed by #36997

Comments

@mvastola
Copy link
Contributor

The rails repository's .yardopts file limits documentation to files matching act*/lib/**/*.rb and railties/lib/**/*.rb.

However, there are several files vital to activestorage that reside within paths matching activestorage/app/**/*.rb. (Also, arguably, the routes for activestorage should be documented.)

In particular, the activestorage models and included files at activestorage/app/models/active_storage/*.rb are crucial understanding for anyone coding custom analyzers, previewers, etc.

As documentation already exists within these files, this was likely an oversight. I'd like to request whitelisting these directories for documentation purposes.

@prathamesh-sonpatki
Copy link
Member

cc @georgeclaghorn

@rails-bot
Copy link

rails-bot bot commented Aug 20, 2019

This issue has been automatically marked as stale because it has not been commented on for at least three months.
The resources of the Rails team are limited, and so we are asking for your help.
If you can still reproduce this error on the 5-2-stable branch or on master, please reply with all of the information you have about it in order to keep the issue open.
Thank you for all your contributions.

@rails-bot rails-bot bot added the stale label Aug 20, 2019
@mvastola
Copy link
Contributor Author

@rails-bot this is still happening with master. (Just checkout and run yard server.)
I'm going to submit a commit though. It's a one-line fix.

@mvastola mvastola reopened this Aug 20, 2019
@rails-bot rails-bot bot removed the stale label Aug 20, 2019
@mvastola
Copy link
Contributor Author

Er. Closed accidentally.

@rails-bot
Copy link

rails-bot bot commented Nov 18, 2019

This issue has been automatically marked as stale because it has not been commented on for at least three months.
The resources of the Rails team are limited, and so we are asking for your help.
If you can still reproduce this error on the 6-0-stable branch or on master, please reply with all of the information you have about it in order to keep the issue open.
Thank you for all your contributions.

@rails-bot rails-bot bot added the stale label Nov 18, 2019
@mvastola
Copy link
Contributor Author

Still an issue on master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants