search

zericardo / sci-corpus

Scientific corpus manager.
6 stars 1 forks source link

Internal docs and wiki #31

Open dpizetta opened 10 years ago

dpizetta commented 10 years ago

We need to provide a

In this first moment we don't need to provide parameters and returns from functions. Just the initial comment.

The Wiki page should provide simple usage functionality.

zericardo commented 10 years ago

I can start writing the internal docs.

zericardo commented 10 years ago

I suggest that everybody should use the standard that I used in the "crazyRepetition" method on the container file, so it will be easier to generate the files. With sphinx we can use this standard to generate docs similar to those of "networkx" project.

dpizetta commented 10 years ago

Isto! We should do like that :)

dpizetta commented 10 years ago

Zé, what is the difference between when you put from Parameters: Returns:

You write almost the same things in both?

dpizetta commented 10 years ago

Read from Function Definitions, they also have a UNITEST... https://pythonhosted.org/an_example_pypi_project/sphinx.html

dpizetta commented 10 years ago

Hey guys, about the documentation (internal and wiki) are you doing?

tiagocampo commented 10 years ago

Nope.

On Tue, May 13, 2014 at 10:57 AM, Daniel Pizetta notifications@github.comwrote:

Hey guys, about the documentation (internal and wiki) are you doing?

— Reply to this email directly or view it on GitHubhttps://github.com/zericardo182/sci-corpus/issues/31#issuecomment-42957922 .

                  Tiago de Campos
  ----------------------------------------------------------

                Skype: tiagocampo1
  https://www.facebook.com/tiagodecampo

zericardo commented 10 years ago

Nope 2.