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.

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

Extend cross referencing options with values #10883

Merged
merged 1 commit into from Oct 2, 2022

Conversation

marxin
Copy link
Contributor

@marxin marxin commented Sep 29, 2022

This supports a commonly used format when it comes to optional argument: -fauto-profile[=path], where path is optional part. Plus it supports a format when space is used: -fauto-profile path.

Extends: #10840

@marxin marxin force-pushed the option-ref-optional-part branch 2 times, most recently from de04e51 to f0abef2 Compare September 29, 2022 09:16
@marxin marxin changed the title option ref: support optional part with '[=value]' option ref: support optional part with '[=value]' or ' value' Sep 29, 2022
@marxin
Copy link
Contributor Author

marxin commented Sep 30, 2022

What do you think @AA-Turner?

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

+1

sphinx/domains/std.py Outdated Show resolved Hide resolved
sphinx/domains/std.py Outdated Show resolved Hide resolved
tests/roots/test-root/objects.txt Outdated Show resolved Hide resolved
This supports a commonly used format when it comes to optional argument:
-fauto-profile[=path], where `path` is optional part. Plus it supports
a format when space is used: -fauto-profile path.

Extends: sphinx-doc#10840
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner
Copy link
Member

@marxin please don't force push, it makes review much more difficult after leaving comments.

A

@marxin
Copy link
Contributor Author

marxin commented Oct 2, 2022

All right, so you prefer leaving there the "Suggested change" commits, right?

@AA-Turner
Copy link
Member

Yes, I squash merge on commit.

A

@AA-Turner AA-Turner changed the title option ref: support optional part with '[=value]' or ' value' Extend cross referencing options with values Oct 2, 2022
@AA-Turner AA-Turner merged commit 0a91adb into sphinx-doc:5.x Oct 2, 2022
@AA-Turner
Copy link
Member

Thanks!

A

@marxin
Copy link
Contributor Author

marxin commented Oct 2, 2022

Yes, I squash merge on commit.

Makes sense, will do that next time.

@marxin
Copy link
Contributor Author

marxin commented Oct 2, 2022

Thanks!

I thank you for a nice negotiation we made.

@marxin marxin deleted the option-ref-optional-part branch October 2, 2022 15:21
marxin added a commit to marxin/sphinx that referenced this pull request Oct 2, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants