Skip to content

Provide more hints about using the documentation - #442

Open
sogaiu wants to merge 1 commit into
janet-lang:masterfrom
sogaiu:explain-more-about-core-api-page
Open

Provide more hints about using the documentation#442
sogaiu wants to merge 1 commit into
janet-lang:masterfrom
sogaiu:explain-more-about-core-api-page

Conversation

@sogaiu

@sogaiu sogaiu commented Sep 6, 2026

Copy link
Copy Markdown
Collaborator

This PR contains changes that attempt to explain more about using Janet's documentation.

It includes:

  • An addition explaining the use of the doc macro with strings to search for binding names as well as a sample invocation.
  • Spelling out that each binding on the Core API page has certain info listed (e.g. a link to source, etc.).
  • A note about how the docstrings assume that the reader has gotten some degree of familiarity of Janet. Additionally, some specific hints about what one might use to help interpret docstrings were added.
  • Some shortening of existing text.
  • Whitespace and reflow changes.

@sogaiu
sogaiu marked this pull request as ready for review September 6, 2026 06:50

@pepe pepe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@sogaiu
sogaiu force-pushed the explain-more-about-core-api-page branch from 69b56b7 to 5ab4382 Compare September 7, 2026 04:34
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.

2 participants