Skip to content

Tweak some fiber-related docstrings#1708

Merged
bakpakin merged 1 commit intojanet-lang:masterfrom
sogaiu:fiber-docstring-tweaks
Jan 29, 2026
Merged

Tweak some fiber-related docstrings#1708
bakpakin merged 1 commit intojanet-lang:masterfrom
sogaiu:fiber-docstring-tweaks

Conversation

@sogaiu
Copy link
Contributor

@sogaiu sogaiu commented Jan 29, 2026

This PR suggests some changes to some docstrings that mention fibers and/or tasks.

While investigating ev/cancel via this Zulip topic, it seemed that the docstring for ev/cancel might be adjusted a bit to match the modified behavior hinted at here.

The examination process suggested that possibly some other fiber / task-related docstrings might be changed a bit as well.

The functions / macros in question include:

  • ev/all-tasks
  • ev/call
  • ev/cancel
  • ev/gather
  • ev/go
  • ev/spawn
  • fiber/root

Except for those of ev/gather, the changes are about mentioning tasks more explicitly.

@bakpakin
Copy link
Member

LGTM - there are certainly a number of places where we can both clarify this and enforce it in code.

@bakpakin bakpakin merged commit 4c21dc3 into janet-lang:master Jan 29, 2026
13 checks 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.

2 participants