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

git-shortlog: add page #2044

Merged
merged 4 commits into from
Mar 27, 2018
Merged

Conversation

thescalaguy
Copy link
Contributor


  • The page (if new), does not already exist in the repo.

  • The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • The page has 8 or fewer examples.

  • The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited.

  • The page follows the contributing guidelines.

@owenvoke owenvoke added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Mar 26, 2018
Copy link
Member

@owenvoke owenvoke left a comment

Choose a reason for hiding this comment

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

Looks fine to me. 👍

- add tokens around variables.
- add backticks around git log.

`git shortlog -n`

- View a summary of all the commits made, grouped by the commiter identities:
Copy link
Member

Choose a reason for hiding this comment

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

What does commiter identities mean ? Is it just name ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

AFAIK, it's the combination of email and author name. The man pages don't say much.

Copy link
Member

Choose a reason for hiding this comment

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

I couldn't even find this option in the man page. Can you paste the text here ?

Copy link
Member

Choose a reason for hiding this comment

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

-c / --committer

Collect and show committer identities instead of authors.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it does seem to be email and name. Let's change the description to reflect that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@agnivade Done. I've kept "committer identities" in the description to make the man pages easy to understand if someone goes from TLDR to man

@tldr-bot
Copy link

The build for this PR has failed with the following error(s):

Error: Parse error on line 6:
...nes in files.  - 
--------------------^
Expecting 'EXAMPLE_DESCRIPTION', got '1'
pages/common/git-grep.md:3: TLDR004 Command descriptions should end in a period
pages/common/git-grep.md:5: TLDR002 A single space should precede a sentence

Please fix the error(s) and push again.

@agnivade agnivade merged commit da60c8e into tldr-pages:master Mar 27, 2018
lamar-frankie pushed a commit to lamar-frankie/tldr that referenced this pull request Jun 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants