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

rake rdoc does not work as advertised #77

Closed
jedeleh opened this issue Jun 7, 2011 · 1 comment
Closed

rake rdoc does not work as advertised #77

jedeleh opened this issue Jun 7, 2011 · 1 comment
Assignees

Comments

@jedeleh
Copy link

jedeleh commented Jun 7, 2011

The readme file on github says to do this to get at documentation:

Run rake rdoc to generate the API docs and see CollectiveIdea::Acts::NestedSet::Model::SingletonMethods for more info.

There are two issues here. First, not all projects have an rdoc rake task. I had to run 'gem rdoc awesome_nested_set' to generate the rdoc. Second, once the rdoc is generated, there is no documentation for CollectiveIdea::Acts::NestedSet::Model::SingletonMethods.

parndt added a commit that referenced this issue Aug 1, 2011
… renamed to README.rdoc, updated README.rdoc to reflect SingletonMethods being gone now. (Related to Issue #77).
@parndt
Copy link
Collaborator

parndt commented Aug 1, 2011

@jedeleh it seems SingletonMethods was refactored away. I think what the docs mean is to run rake rdoc inside the source code of awesome_nested_set which isn't very clear.

Would you like to reword this with proper instructions and submit a pull request?

@ghost ghost assigned parndt Aug 1, 2011
@parndt parndt closed this as completed Aug 14, 2011
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

No branches or pull requests

2 participants