Skip to content

Conversation

@waldyrious
Copy link
Member

@waldyrious waldyrious commented Nov 1, 2025

Checklist

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR contains at most 5 new pages.
  • The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

Reference issue: #

@github-actions github-actions bot added page edit Changes to an existing page(s). review needed Prioritized PRs marked for reviews from maintainers. labels Nov 1, 2025
@waldyrious waldyrious force-pushed the git-fetch-pull-other branch from 9b3a26c to 02a9d74 Compare November 1, 2025 00:28
@tldr-bot

This comment was marked as resolved.

@kbdharun kbdharun added the hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. label Nov 1, 2025
@sbrl
Copy link
Member

sbrl commented Nov 3, 2025

.....but wouldn't this now say that the branch can't be changed, since it isn't in {{braces}}, @Managor?

@Managor
Copy link
Member

Managor commented Nov 4, 2025

No. The point is to match the description. If the description is explixit, then the example command is explicit as well.

@sebastiaanspeck sebastiaanspeck changed the title git-fetch: Add example for updating another branch git-fetch: add example for updating another branch Nov 4, 2025
@Managor Managor merged commit ca40d91 into main Nov 4, 2025
9 checks passed
@Managor Managor deleted the git-fetch-pull-other branch November 4, 2025 09:06
@waldyrious
Copy link
Member Author

For the record, I do agree with @sbrl that it feels awkward to not mark the "main" as placeholders just because the description refers to that explicitly.

I believe we are yet to define a single standard for how to specify command arguments —i.e. use concrete examples or more generic placeholder names— and whether to mark that difference using the placeholder syntax. For example, it feels almost backward that in the sed page, we have the following example:

- [p]rint only the first line to `stdout`:

`{{command}} | sed {{[-n|--quiet]}} '1p'`

It's almost as we're saying that the part that is core to that example, in terms of determining its behavior (i.e. the -n option) is replaceable, whereas the actual variable bit (1p) is hardcoded.

But hey, that's a discussion for another time and place. I just wanted to make my thoughts explicit since the point was raised here.

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

Labels

hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. page edit Changes to an existing page(s). review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants