Skip to content

[github] Update the docstrings#615

Closed
vchrombie wants to merge 1 commit intochaoss:masterfrom
vchrombie:fix-github-docstrings
Closed

[github] Update the docstrings#615
vchrombie wants to merge 1 commit intochaoss:masterfrom
vchrombie:fix-github-docstrings

Conversation

@vchrombie
Copy link
Copy Markdown
Member

@vchrombie vchrombie commented Feb 12, 2020

I was just lurking around the GitHub Backend code and found the docstrings are not updated. GitHub Backend extracts three categories of information. This PR updates the docstrings.

Please let me know if I have to change anything or revert back something. 🙂

@coveralls
Copy link
Copy Markdown

coveralls commented Feb 12, 2020 •
edited
Loading

Coverage Status

Coverage remained the same at 97.608% when pulling 404976a on vchrombie:fix-github-docstrings into 28d4b13 on chaoss:master.

@valeriocos valeriocos self-requested a review February 12, 2020 18:09
valeriocos
valeriocos reviewed Feb 12, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@valeriocos valeriocos left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @vchrombie, just a minor comment, could you update the version number of the backend to 0.25.1 (https://github.com/chaoss/grimoirelab-perceval/blob/master/perceval/backends/core/github.py#L99) ?

@vchrombie
Copy link
Copy Markdown
Member Author

vchrombie commented Feb 12, 2020

Thanks for the PR @vchrombie, just a minor comment, could you update the version number of the backend to 0.25.1 (https://github.com/chaoss/grimoirelab-perceval/blob/master/perceval/backends/core/github.py#L99) ?

Sure @valeriocos
I will do that.

@vchrombie
[github] Update the docstrings
404976a 
GitHub Backend extracts three categories of information. This
commit updates the docstrings.

Signed-off-by: Venu Vardhan Reddy Tekula <[email protected]>
@vchrombie vchrombie force-pushed the fix-github-docstrings branch from 782a245 to 404976a Compare February 12, 2020 19:25
@vchrombie
Copy link
Copy Markdown
Member Author

vchrombie commented Feb 12, 2020

I hope the changes are good to go.
@valeriocos, please let me know your opinion.

@valeriocos valeriocos self-requested a review February 12, 2020 19:51
valeriocos
valeriocos approved these changes Feb 12, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@valeriocos valeriocos 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 for the quick reaction

@sduenas sduenas closed this in 3feb585 Feb 13, 2020
@sduenas
Copy link
Copy Markdown
Member

sduenas commented Feb 13, 2020

I merged this PR but I don't know why this doesn't appear as merged here.

@vchrombie
Copy link
Copy Markdown
Member Author

vchrombie commented Feb 13, 2020

I merged this PR but I don't know why this doesn't appear as merged here.

The code is merged, so I think it is not a big problem.

@vchrombie vchrombie deleted the fix-github-docstrings branch March 5, 2020 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sduenas sduenas sduenas approved these changes

+1 more reviewer

@valeriocos valeriocos valeriocos approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vchrombie @coveralls @sduenas @valeriocos