Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

dochelpers [PY: PY] macro handling cannot deal with [] in the conditional docs #7225

Closed
mih opened this issue Dec 13, 2022 · 2 comments · Fixed by #7226
Closed

dochelpers [PY: PY] macro handling cannot deal with [] in the conditional docs #7225

mih opened this issue Dec 13, 2022 · 2 comments · Fixed by #7226
Assignees
@bpoldrack

Comments

@mih
Copy link
Member

mih commented Dec 13, 2022

The datalad-next credentials command shows it in the CLI for its spec parameter. It fails to find the macro and leaves it in
@bpoldrack bpoldrack self-assigned this Dec 13, 2022
@bpoldrack
Copy link
Member

bpoldrack commented Dec 13, 2022 •
edited
Loading

Looking into it.

Update: Seems like the regexes, both for CMD and PY, are explicitly not matching something that contains [, ] within. I guess, the intention is to not be greedy when matching.

And both directions are subject to it: alter_interface_docs_for_cmdline as well as alter_interface_docs_for_api.

bpoldrack added a commit to bpoldrack/datalad that referenced this issue Dec 13, 2022
@bpoldrack
Allow for brackets in PY&CMD doc markups
b63026e 
Fixes datalad#7225

Interface specific substitutions did not work with nested brackets (and
for some reason also not crossing newlines).

Looks like those regexes were simply meant to not be greedy.
@bpoldrack bpoldrack mentioned this issue Dec 13, 2022
Merged
bpoldrack added a commit to bpoldrack/datalad that referenced this issue Dec 14, 2022
@bpoldrack
Allow for brackets in PY&CMD doc markups
ad61af7 
Fixes datalad#7225

Interface specific substitutions did not work with nested brackets (and
for some reason also not crossing newlines).

Looks like those regexes were simply meant to not be greedy.
@yarikoptic-gitmate
Copy link
Collaborator

Issue fixed in 0.17.10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bpoldrack bpoldrack

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allow for brackets in PY&CMD doc markups bpoldrack/datalad
3 participants
@mih @bpoldrack @yarikoptic-gitmate