#2526 Generated plugin RDoc should include all code within plugin load_paths - Ruby on Rails

Type	To find
responsible:me	tickets assigned to you
tagged:"@high"	tickets tagged @high
milestone:next	tickets in the upcoming milestone
state:invalid	tickets with the state invalid
created:"last week"	tickets created last week
sort:number, importance, updated	tickets sorted by #, importance or updated
Combine keywords for powerful searching.
Use advanced searching »

This project is archived and is in readonly mode.

#2526 ✓stale

Generated plugin RDoc should include all code within plugin load_paths

Reported by James Adam | April 20th, 2009 @ 11:27 AM | in 3.x

At the moment, generating the RDoc for a plugin will only include the code underneath a plugins lib directory. Since plugins can now validly include an app directory with documentation-worthy code within it, these paths should be included in the documentation path.

The simplest and most robust solution would be to actually use the results of the Plugin#load_paths method, but this would require access to the list of loaded plugins outside of the Rails initialization process.

So, would it be worth me writing a patch to make a Rails.plugins or Rails.loaded_plugins set available, reflecting the contents of Rails::Initializer#loaded_plugins at the end of the environment load?

Comments and changes to this ticket

You flagged this item as spam.
Samuel Williams April 21st, 2009 @ 11:01 AM
I think it is a good idea.

+1

It makes sense to simplify things.

If there is anything I can do to help, please let me know.

Kind regards, Samuel
You flagged this item as spam.
Tekin April 21st, 2009 @ 03:29 PM
+1
You flagged this item as spam.
Peter Jones April 21st, 2009 @ 05:01 PM
+1 This is a great idea.
Pratik April 21st, 2009 @ 05:33 PM
- Tag changed from “doc, documentation, enhancement, initialization, initializer, plugin, plugins” to “documentation, enhancement, initialization, initializer, plugin, plugins”
You flagged this item as spam.
Rob Morris April 21st, 2009 @ 07:41 PM
+1, simple and clean enhancement
Jeremy Kemper May 5th, 2009 @ 07:02 PM
- State changed from “new” to “open”
Yes! Please do.
You flagged this item as spam.
Peter Boling October 2nd, 2009 @ 04:21 PM
+1 Excellent idea!
Jeremy Kemper May 4th, 2010 @ 06:48 PM
- Milestone changed from “2.x” to “3.x”
[bulk edit]
Santiago Pastorino February 2nd, 2011 @ 05:03 PM
- Importance changed from “” to “”
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 core team are limited, and so we are asking for your help. If you can still reproduce this error on the 3-0-stable branch or on master, please reply with all of the information you have about it and add "[state:open]" to your comment. This will reopen the ticket for review. Likewise, if you feel that this is a very important feature for Rails to include, please reply with your explanation so we can consider it.

Thank you for all your contributions, and we hope you will understand this step to focus our efforts where they are most helpful.
Santiago Pastorino February 2nd, 2011 @ 05:03 PM
- State changed from “open” to “stale”