Example to show How to get Commit Date #927
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Simply awesome, kudos to building the docs locally for test evidence! One small suggestion, could you add a real example and print out the result, like what the other examples do? |
|
@sfdye, good catch. I've updated the example. |
candrikos
pushed a commit
to candrikos/PyGithub
that referenced
this pull request
Sep 25, 2020
## What does this change do? Adds a small example of how to get at the date a commit took place. ### Changes #### doc/examples/Commit.rst Adds a block of code that demonstrates how to get at a commit's date. ## Motivation This example is in the spirit of PyGithub#874. When I began using PyGithub it was not readily apparent to me where the commit date was being abstracted to. Being unfamiliar with Git's API, it took some convincing for me to be satisfied that the `Commit.commit.author/committer.date` path would get me the commit date. I would hope that this would save somebody a little bit of time in the future. ## How has this been tested? I've built the docs locally and made sure the HTML is generated as expected. ## Screenshots 
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change do?
Adds a small example of how to get at the date a commit took place.
Changes
doc/examples/Commit.rst
Adds a block of code that demonstrates how to get at a commit's date.
Motivation
This example is in the spirit of #874.
When I began using PyGithub it was not readily apparent to me where the commit date was being abstracted to. Being unfamiliar with Git's API, it took some convincing for me to be satisfied that the
Commit.commit.author/committer.datepath would get me the commit date.I would hope that this would save somebody a little bit of time in the future.
How has this been tested?
I've built the docs locally and made sure the HTML is generated as expected.
Screenshots