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 documentation in github wiki #6

Open
oevans opened this issue Apr 22, 2014 · 0 comments
Open

Provide documentation in github wiki #6

oevans opened this issue Apr 22, 2014 · 0 comments

Comments

@oevans
Copy link
Member

oevans commented Apr 22, 2014

The inline syntax comments are helpful to learn specific functions, but I believe it would be much more user-friendly to provide the documentation in a wiki format now that PortalPy is on Github. Having a wiki with a master list of function names as hyperlinks to specific syntax pages about each function would make it much easier to learn PortalPy and navigate the documentation.

To avoid having to maintain documentation in two locations I would be in favor of removing the comments from each function in the code files and having the wiki be the main source.

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

1 participant