Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

There was a problem

This project is archived and is in readonly mode.

Generated plugin RDoc should include all code within plugin load_paths

#2526

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?

Reported by James Adam · April 20th, 2009 @ 11:27 AM

State: stale
Milestone: 3.x
Assigned to: nobody
Importance: none

Activity

  1. Samuel Williams
    Samuel Williams

    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

    April 21st, 2009 @ 11:01 AM

  2. Tekin
  3. Peter Jones
    Peter Jones

    +1 This is a great idea.

    April 21st, 2009 @ 05:01 PM

  4. Pratik
    Pratik
    • Tag changed from doc, documentation, enhancement, initialization, initializer, plugin, plugins to documentation, enhancement, initialization, initializer, plugin, plugins

    April 21st, 2009 @ 05:33 PM

  5. Rob Morris
    Rob Morris

    +1, simple and clean enhancement

    April 21st, 2009 @ 07:41 PM

  6. Jeremy Kemper
    Jeremy Kemper
    • State changed from new to open

    Yes! Please do.

    May 5th, 2009 @ 07:02 PM

  7. Peter Boling
  8. Jeremy Kemper
    Jeremy Kemper
    • Milestone changed from 2.x to 3.x

    May 4th, 2010 @ 06:48 PM

  9. Santiago Pastorino
    Santiago Pastorino
    • 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.

    February 2nd, 2011 @ 05:03 PM

  10. Santiago Pastorino
    Santiago Pastorino
    • State changed from open to stale

    February 2nd, 2011 @ 05:03 PM