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

Document spork/utf8. #206

Closed
amano-kenji opened this issue Jan 21, 2024 · 4 comments
Closed

Document spork/utf8. #206

amano-kenji opened this issue Jan 21, 2024 · 4 comments

Comments

@amano-kenji
Copy link

It's available, but it's not documented on janet website.

Plus, janet REPL doesn't provide autocompletion for janet modules...

It took some time to discover this module...

@sogaiu
Copy link
Contributor

sogaiu commented Jan 21, 2024

I didn't find a page for spork/utf8 either.

Snooping around, it looks like there are a couple relevant-looking things that are from spork/utf8 though:

But it seems there may not be a page specifically for spork/utf8 (as compared with say, one for spork/argparse).

Perhaps an appropriate file can get added to this directory and when the site is rebuilt things will work out?

Based on what I see for crc, may be something like the following in a file named utf8.mdz?

(import ../gen-docs :as gen-docs)
(import spork/utf8 :export true)
(setdyn :source-linker (partial gen-docs/github-source-linker "janet-lang/spork" gen-docs/spork-version))

{:title "UTF8"
 :nav-title "utf8"
 :template "docpage.html"}
---

## Index

@gen-docs/gen-prefix-current[utf8/]

Don't really know how this works (^^;

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

sogaiu commented Feb 3, 2024

Ok, I tried out the guessed steps above and it seems to work.

Created a related PR #211.

@amano-kenji
Copy link
Author

🐾

bakpakin added a commit that referenced this issue Apr 15, 2024
@sogaiu
Copy link
Contributor

sogaiu commented Jun 6, 2024

It looks like #211 has been merged, so may be this can be closed now.

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