Skip to content

Fix datalad --help to not have *Global options* empty and list options in "options:" section#7028

Merged
mih merged 2 commits into
datalad:maintfrom
yarikoptic:bf-opts
Sep 13, 2022
Merged

Fix datalad --help to not have *Global options* empty and list options in "options:" section#7028
mih merged 2 commits into
datalad:maintfrom
yarikoptic:bf-opts

Conversation

@yarikoptic

Copy link
Copy Markdown
Member

Detected while considering #7027 (note: that one is against master, this one -- maint)

I believe came up as a regression of e89ce43 and since we had no unittest. So I also added a test.

Without this fix --help looked like

options:
  -c (:name|name=value)
...
*Global options*

and nothing at the end after Global options.

@yarikoptic yarikoptic added semver-patch Increment the patch version when merged CHANGELOG-missing When a PR's description does not contain a changelog item, yet. labels Sep 12, 2022
@github-actions github-actions Bot removed the CHANGELOG-missing When a PR's description does not contain a changelog item, yet. label Sep 12, 2022
@yarikoptic

Copy link
Copy Markdown
Member Author

although changelog commit no longer has [ci skip] it seems that github completely skips that updated state in its CI. @jwodder any ideas on why that might be happening?

unfortunately adjusted test fails on travis and appveyor... need to figure why (passes locally). Could be python (argparse) version or how we install for testing... will need to troubleshoot

@jwodder

jwodder commented Sep 12, 2022

Copy link
Copy Markdown
Contributor

@yarikoptic I think this may be because the snippet is pushed using secrets.GITHUB_TOKEN, so GitHub doesn't trigger any workflows in order to avoid a potential infinite loop of workflows.

yarikoptic and others added 2 commits September 12, 2022 12:32
Apparently in python 3.10 it is just "options:" while in 3.8 "optional
arguments:" so we will match both now.

I believe came up as a regression of e89ce43
and since we had no unittest. So I also added a test.

Without this fix  --help looked like

	options:
	  -c (:name|name=value)
	...
	*Global options*

and nothing at the end after *Global options*.
@yarikoptic

Copy link
Copy Markdown
Member Author

@yarikoptic I think this may be because the snippet is pushed using secrets.GITHUB_TOKEN, so GitHub doesn't trigger any workflows in order to avoid a potential infinite loop of workflows.

hm, may be, odd though. I wish there was some log to check on github which might have given explanation. If we would not be able to overcome this limitation, it would be quite suboptimal :-/

@yarikoptic

Copy link
Copy Markdown
Member Author

failures on travis and appveyor unrelated now.

@mih mih left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Works for me! Thx

@mih mih merged commit 91f6949 into datalad:maint Sep 13, 2022
@yarikoptic-gitmate

Copy link
Copy Markdown
Collaborator

PR released in 0.17.6

@yarikoptic yarikoptic deleted the bf-opts branch October 14, 2022 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver-patch Increment the patch version when merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants