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

Write out the test in the README #41

Closed
drj11 opened this issue Jul 13, 2020 · 1 comment
Closed

Write out the test in the README #41

drj11 opened this issue Jul 13, 2020 · 1 comment

Comments

@drj11
Copy link

drj11 commented Jul 13, 2020

Per my review on openjournals/joss-reviews#2400

I agree with your comment on openjournals/joss-reviews#2400 (comment) : gpp's documentation is a sufficient test of gpp. But It would be best for my conscience in checking the check box if this were more explicit.

I recommend:

  • Put "GPP's own documentation uses GPP and generates HTML, LaTeX, and man pages (troff) from one gpp source file" in the first paragraph at the top of the README. It's a good feature of gpp and a useful demonstration of its capabilities.
  • After the README's Documentation section add a Testing section: "gpp -H -Dhtml doc/gpp.pp -o gpp.html builds GPP's HTML document and serves as a basic test; for more see the doc/gpp.pp file".
@logological
Copy link
Owner

Thanks for the suggestion. I'd prefer not to mention this in the lede paragraph as I don't consider it central to the description of what GPP is. However, I've expanded the part of the README where I mention generating the documentation as a test of GPP's capabilities; as you suggested I explicitly gave the command to run and explicitly referenced the doc/gpp.pp file (with a hyperlink). Note that I didn't specifically instruct the user to generate the HTML version of the documentation, since running gpp -H gpp.pp without any further arguments will output a help message with the exact command lines to use to generate the troff, HTML, and LaTeX documentation:

 To get the man page, run:              
    gpp -H -Dman gpp.pp -o gpp.1    

 To get the HTML page, run:             
    gpp -H -Dhtml gpp.pp -o gpp.html

 To get a LaTeX version, run:           
    gpp -H -Dlatex gpp.pp -o gpp.tex

I've also opened a new issue (Issue #45) for a proper test suite, though as I mentioned in the review issue, I think this can be left as future work. (Hopefully I can get around to this some time in the next few weeks or months.)

I hope this is sufficient for you—if not, feel free to reopen this issue.

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

2 participants