Add some jpm declare- docs (#34, #209) #212
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an attempt to address #34 and #209.
It adds a new section to the jpm page that contains some docs for the following
declare-
callables:declare-bin
declare-binscript
declare-headers
declare-manpage
I have seen each of these used in at least one project [1], so it seemed worth doing.
I based the added docs on the docstrings found in
jpm
'sdeclare.janet
. I made some changes though because some things didn't seem right or there seemed to be missing bits.Also snuck in a minor formatting change to a code example. I hope that can be forgiven (^^;
[1] I did not add a docstring for one other construct I found in jpm's
declare.janet
because I have not encountered a single project that uses it.