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.

Sign up for GitHub

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

Jump to bottom

Document using POD #20

Open
oldtechaa opened this issue May 24, 2016 · 2 comments
Open

Document using POD #20

oldtechaa opened this issue May 24, 2016 · 2 comments
Labels
enhancement help wanted minor
Milestone
Style Changes

Comments

@oldtechaa
Copy link
Owner

Currently, the code is documented with a small number of comments. The proper way to do this is to use POD, the Perl standard documentation system. So this will need to be converted and added to.
@oldtechaa oldtechaa added this to the Milestone 7 - Add basic features milestone May 24, 2016
@oldtechaa oldtechaa modified the milestones: Milestone 8 - Add more features., Milestone 7 - Add basic features Jul 21, 2016
@oldtechaa
Copy link
Owner Author

POD is not suited for a GUI program as the kind of documentation we want is not end-user docs.

@oldtechaa
Copy link
Owner Author

The recommended practice, at least for modules, is to use POD. So, at least for our widget module, we will eventually use POD.

@oldtechaa oldtechaa reopened this Jun 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted minor
Projects
None yet
Milestone
Style Changes
Development

No branches or pull requests
1 participant
@oldtechaa