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

revsets.md: clarify string patterns, and file patterns #2484

Merged
merged 1 commit into from
Nov 1, 2023

Conversation

ilyagr
Copy link
Contributor

@ilyagr ilyagr commented Oct 31, 2023

I had to increase indent on two list items for multiple paragraphs to work in
MkDocs.

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have updated the config schema (cli/src/config-schema.json)
  • I have added tests to cover my changes

@ilyagr ilyagr added the documentation Improvements or additions to documentation label Oct 31, 2023
@ilyagr
Copy link
Contributor Author

ilyagr commented Oct 31, 2023

@martinvonz or @yuja, please check for correctness. I had to experiment a bit to get what I think are the correct rules.

In particular, I can't think of a situation where quotes are not optional, but maybe there is some or we want to deprecate it? (It's awfully convenient to do description(foo), though, and this is used in all the examples in the docs).

@ilyagr ilyagr marked this pull request as ready for review October 31, 2023 19:48
@ilyagr ilyagr force-pushed the strpat branch 2 times, most recently from 9453984 to 984520a Compare October 31, 2023 19:54
@ilyagr ilyagr marked this pull request as draft October 31, 2023 19:54
@ilyagr ilyagr marked this pull request as ready for review October 31, 2023 20:02
@ilyagr ilyagr changed the title revsets.md: reword mentions of string patterns, clarify file patterns revsets.md: clarify string patterns, and file patterns Oct 31, 2023
@ilyagr ilyagr force-pushed the strpat branch 3 times, most recently from e588189 to fccb77e Compare October 31, 2023 20:10
@ilyagr
Copy link
Contributor Author

ilyagr commented Oct 31, 2023

I seem to have gotten it wrong, it's ~fixed now. I can also postpone documenting the current files syntax and we can fix it later.

@ilyagr ilyagr force-pushed the strpat branch 6 times, most recently from 2f442e6 to 8057f0e Compare October 31, 2023 20:24
@ilyagr
Copy link
Contributor Author

ilyagr commented Oct 31, 2023

The indentation change is not very pretty, but making it more consistent would require some trial and error with what both MkDocs and GitHub accept.

Copy link
Member

@martinvonz martinvonz left a comment

Choose a reason for hiding this comment

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

LGTM, but Yuya knows this best

Copy link
Contributor

@yuja yuja left a comment

Choose a reason for hiding this comment

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

lgtm, thanks.

docs/revsets.md Show resolved Hide resolved
docs/revsets.md Outdated Show resolved Hide resolved
@ilyagr ilyagr force-pushed the strpat branch 3 times, most recently from 58532c9 to 9c1e294 Compare November 1, 2023 00:04
I had to increase indent on two list items for multiple paragraphs to work in
MkDocs.
@ilyagr ilyagr merged commit a3f21f7 into jj-vcs:main Nov 1, 2023
14 checks passed
@ilyagr ilyagr deleted the strpat branch November 1, 2023 00:49
@ilyagr
Copy link
Contributor Author

ilyagr commented Nov 1, 2023

Thanks, Yuya and Martin!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants