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

jpm declare-binscript is not documented on the website. #34

Open
andrewchambers opened this issue Jan 6, 2020 · 3 comments
Open

jpm declare-binscript is not documented on the website. #34

andrewchambers opened this issue Jan 6, 2020 · 3 comments

Comments

@andrewchambers
Copy link
Member

No description provided.

@sogaiu
Copy link
Contributor

sogaiu commented Apr 9, 2022

Until there are more docs, jpm's declare.janet might be worth taking a look at. It has defn forms for:

  • declare-native
  • declare-source
  • declare-headers
  • declare-bin
  • declare-executable
  • declare-binscript
  • declare-archive
  • declare-manpage
  • declare-project

...and all of them have docstrings.

@sogaiu
Copy link
Contributor

sogaiu commented Feb 3, 2024

The current state of things appear to be that of the declare- contructs mentioned above, the following seem to lack documentation on the website:

I have not found a single project that uses declare-archive, so I think it might be better to not document it at this time. It's unclear to me whether the functionality will be maintained / kept around.


For reference, declare-binscript's docstring is currently:

Declare a janet file to be installed as an executable script. Creates a shim on windows. If hardcode is true, will insert code into the script such that it will run correctly even when JANET_PATH is changed. if auto-shebang is truthy, will also automatically insert a correct shebang line.

sogaiu pushed a commit to sogaiu/janet-lang.org that referenced this issue Feb 3, 2024
bakpakin added a commit that referenced this issue Apr 15, 2024
@sogaiu
Copy link
Contributor

sogaiu commented Jun 6, 2024

As #212 has been merged, I think this one can be closed now.

That doesn't seem to be something I can do though.

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