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

Make documentation for a whole library #1

Open
augustohp opened this issue Mar 19, 2012 · 9 comments
Open

Make documentation for a whole library #1

augustohp opened this issue Mar 19, 2012 · 9 comments
Milestone

Comments

@augustohp
Copy link
Member

We need to use Respect/Doc in other Respect projects, but first we need to be able to receive a namespace and generate the docs.

Happy Panda

@alganet
Copy link
Member

alganet commented Mar 20, 2012

Basic stuff is done, we need a little more fixes to 1.0.

@kinncj
Copy link

kinncj commented Mar 21, 2012

http://www.phpunit.de/manual/3.1/en/other-uses-for-tests.html
Will have something like this too?

@alganet
Copy link
Member

alganet commented Mar 21, 2012

Very soon! Our unit test method names are already formatted to be descriptive enough to generate awesome behavior descriptions!

@kinncj
Copy link

kinncj commented Mar 21, 2012

Can i help u with something? :)

@alganet
Copy link
Member

alganet commented Mar 21, 2012

I'm inviting you to our Trello board! If you'd like to develop this feature, we can discuss it there (or here, in another specific issue) and share our mindsets.

@kinncj
Copy link

kinncj commented Mar 21, 2012

I'll try... i'm not the best coder...
By the way, i'm joining Trello board!

@augustohp
Copy link
Member Author

We need also to document (somehow in the code) what convetions we are using to generate the docs, like:

  • We use PSR#0 autoloading with include_path
  • We expect (for examples) that the TestCase is the name of the class (full namespaced name) with the "Test" suffix and this testSuite have to hold test cases with a specific name that we will expand in the future
  • We only document the API code, so we care about: public and static properties and messages

By now, i think that these are the conventions we are using. Am i missing something?

@alganet
Copy link
Member

alganet commented Mar 21, 2012

We need to put up a full sample with features. Maybe the Doc itself. Conventions by sample, under-engineering style.

@augustohp
Copy link
Member Author

Of course =D

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

No branches or pull requests

3 participants