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

Provide better documentation for nodes. #9

Open
glesica opened this issue Mar 14, 2015 · 2 comments
Open

Provide better documentation for nodes. #9

glesica opened this issue Mar 14, 2015 · 2 comments

Comments

@glesica
Copy link
Member

glesica commented Mar 14, 2015

It is not clear from the code how NodePosition and some of the other concepts within Node.jl actually work. For instance, are they 0-indexed or 1-indexed? Add some comments to explain these concepts. Eventually, the comments can form the basis of some actual documentation.

@ahalwright
Copy link
Contributor

I can work on this over the weekend. But my first priority is to
compose a letter to Brian Arthur that might set up a meeting for late
this month.

Alden

On Fri, Mar 13, 2015, at 18:39, George Lesica wrote:

It is not clear from the code how NodePosition and some of the other
concepts within Node.jl actually work. For instance, are they 0-indexed
or 1-indexed? Add some comments to explain these concepts. Eventually,
the comments can form the basis of some actual documentation.


Reply to this email directly or view it on GitHub:
#9

@glesica
Copy link
Member Author

glesica commented Mar 14, 2015

That's fine, I'm just creating issues in GitHub to keep track of things
that should be done eventually.

George Lesica
george@lesica.com

On Sat, Mar 14, 2015, at 01:22 AM, Alden Wright wrote:

I can work on this over the weekend. But my first priority is to
compose a letter to Brian Arthur that might set up a meeting for late
this month.

Alden

On Fri, Mar 13, 2015, at 18:39, George Lesica wrote:

It is not clear from the code how NodePosition and some of the other
concepts within Node.jl actually work. For instance, are they 0-indexed
or 1-indexed? Add some comments to explain these concepts. Eventually,
the comments can form the basis of some actual documentation.


Reply to this email directly or view it on GitHub:
#9


Reply to this email directly or view it on GitHub:
#9 (comment)

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

2 participants