Skip to content

Conversation

@sogaiu
Copy link
Collaborator

@sogaiu sogaiu commented Feb 5, 2025

This PR is an attempt to improve the consistency of some of the existing examples.

Apart from a minor adjustment to correct an example, the changes basically are of three types:

  1. Try to use the # -> <value> comment to describe return values only
  2. Try to use the # -> error: ... (or # -> compile error: ..., etc.) comment(s) to describe errors
  3. Use comments to describe printed output -- AFAICT, this is more in line with how most of the other examples do things

Update: On a side note, I've drafted something with more details on these types of bits here.

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

@sogaiu sogaiu merged commit 8a31ba5 into janet-lang:master Feb 5, 2025
1 check passed
@rwtolbert
Copy link
Contributor

+1

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