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

Add some jpm declare- docs (#34, #209) #212

Merged
merged 1 commit into from
Apr 15, 2024

Conversation

sogaiu
Copy link
Contributor

@sogaiu sogaiu commented Feb 3, 2024

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's declare.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.

@sogaiu sogaiu mentioned this pull request Feb 3, 2024
Copy link
Member

@pepe pepe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bakpakin bakpakin merged commit 2b3f76c into janet-lang:master Apr 15, 2024
1 check passed
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

Successfully merging this pull request may close these issues.

3 participants