You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#!/usr/bin/env bash# @file testdoc.sh# @brief Demo# @description Demonstration.# @description Something# something dark side.## @example# testme()## @noargstestme() {
echo"Hello"
}
if [[ 1 -eq 2 ]];then# @description Another bit of# comment.## @example# testus()## @noargstestus() {
echo"Hello"
}
fi
I would expect similar documentation output for both testme and testus - however, I get testus missing its description (but it does include the examples). I can't quite see why this is happening myself, but I'm not familiar with gawk.
Here is the output with debug mode enabled: using:
[note: I did change the backslashes in the outputted code samples to be single quote marks to avoid Github handling it as formatting]
Platform
Docker: debian:bullseye
GNU Awk version: 5.1.0 API: 3.0
shdoc commit version 433a0ba (6th April)
(And before anyone asks, no that is not real in use code, but I've just reduced it down to a test case - there is a reason I've got a function within an if statement and it is formatted by shfmt, checked by shellcheck and runs on in my Bash 5 environment - so I think it's valid code ;) )
- Add common code for multiline support for:
description, example, stdout, stderr, stdin, set, see, and exitcode.
- `li-preprocess` style adds indentation to multiple line list entries.
- replace space by generic `[[:blank:]]` in `exitcode` style `from`
regex.
Given the following test file:
I would expect similar documentation output for both
testme
andtestus
- however, I gettestus
missing its description (but it does include the examples). I can't quite see why this is happening myself, but I'm not familiar withgawk
.Here is the output with debug mode enabled: using:
[note: I did change the backslashes in the outputted code samples to be single quote marks to avoid Github handling it as formatting]
Platform
Docker: debian:bullseye
GNU Awk version: 5.1.0 API: 3.0
shdoc commit version 433a0ba (6th April)
(And before anyone asks, no that is not real in use code, but I've just reduced it down to a test case - there is a reason I've got a function within an
if
statement and it is formatted by shfmt, checked by shellcheck and runs on in my Bash 5 environment - so I think it's valid code ;) )( How did I miss #21 ? )
The text was updated successfully, but these errors were encountered: