Skip to content

Add @requires#8

Merged
GB609 merged 2 commits intoGB609:masterfrom
jbrubake:add-requires
Mar 23, 2026
Merged

Add @requires#8
GB609 merged 2 commits intoGB609:masterfrom
jbrubake:add-requires

Conversation

@jbrubake
Copy link
Copy Markdown

Add file- or function-level @requires. Each @requires is formatted as an unordered list item and can be multiple lines. I did notice some oddities with indentation of multi-line @requires and putting them before the @description but this was consistent with how @std* is handled and @requires re-uses that code.

From the added examples:

# @file libexample
...
# @requires foo
# @requires bar

# @description My super function.
...
# @requires Some very specific requirements
...
say-hello() {

is formatted as:

libexample

...

Requires

  • foo
  • bar
    ...

say-hello

My super function
...

Requires

  • Some very specific requirements

@GB609
Copy link
Copy Markdown
Owner

GB609 commented Mar 16, 2026

Hey. Thanks for the PRs. I'll have a look at it as soon as i can, i'm a bit more busy with regular work than i'd like to be.

Copy link
Copy Markdown
Owner

@GB609 GB609 left a comment

Choose a reason for hiding this comment

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

Thanks again for the contribution. This is actually an annotation I was planning to add as well.
There's only one small change i'd like you to make.

@GB609 GB609 merged commit 6564117 into GB609:master Mar 23, 2026
1 check passed
@jbrubake jbrubake deleted the add-requires branch March 26, 2026 13:21
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