Skip to content

docstrings: freshen parse-args#136

Merged
borkdude merged 1 commit intomainfrom
lread/docstring-parse-args-stale
Mar 6, 2026
Merged

docstrings: freshen parse-args#136
borkdude merged 1 commit intomainfrom
lread/docstring-parse-args-stale

Conversation

@lread
Copy link
Contributor

@lread lread commented Mar 6, 2026

Freshen docstring for parse-args.

This includes a circle-back to parse-opts docstring:

  • to better explain metadata.
  • correct an example that should have included metadata

Also turfed two top-level (#_ discarded) fns with clearly stale code.

Also noticed that parse-cmd toc summary was not presenting well in API.md, did a minor tweak.

Closes #132

Freshen docstring for `parse-args`.

This includes a circle-back to `parse-opts` docstring:
* to better explain metadata.
* correct an example that should have included metadata

Also turfed two top-level (`#_` discarded) fns with clearly stale code.

Also noticed that `parse-cmd` toc summary was not presenting well in API.md,
did a minor tweak.

Closes #132
@borkdude borkdude merged commit 76a5fea into main Mar 6, 2026
20 checks passed
@borkdude
Copy link
Contributor

borkdude commented Mar 6, 2026

Thanks!

@borkdude borkdude deleted the lread/docstring-parse-args-stale branch March 6, 2026 18:36
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.

docs: parse-args docstring might be a bit stale/confusing?

2 participants