#173 Add more document to request-repo and request-branch
Merged by cqi. Opened by cqi.
cqi/fedpkg more-doc-to-request-repo-branch  into  master

Download 173.patch

/cc @mprahl

You could probably move this to the top of the file with the other imports.

"Before requesting new" => "Before requesting a new"

Suggestion:
"you need to get your own pagure.io API token from your Pagure account's API tokens page https://{1}/settings/token/new" => " you need to generate a pagure.io API token at https://{1}/settings/token/new"

"into local user configuration" => "into your local user configuration located at"

Suggestion:
"example," => "example:"

Suggestion:
"A basic example to request a repository for package foo, command could be" => "Below is a basic example of the command to request a dist-git repository for the package foo:"

Would it make sense to switch the order here? Start with the simpler case and then show how to do the request it if you don't have a local clone?

Nice trick

"to request-repo" => "to the request-repo"

"Dist-git branch could be requested in following cases" => "Below are various examples of requesting a dist-git branch."

Suggestion:
"created. For example," => "created:"

"inside cloned package" => "inside a cloned package"

Suggestion:
"repository. For example," => "repository:"

@cqi thanks a lot for doing this. I was focusing my efforts on PR #172 before doing this but you beat me to it and I greatly appreciate it.

I made some comments on the grammar and formatting. The ones with "Suggestion:" in the beginning of the comment suggest I recommend it but it's okay if you want to keep it as is.

rebased onto c929f7b5b102cd294f619367c49a900447bf5e0c

Thank you all for review. Docstrings are updated according to your comments.

"for requested" => "for the requested"

+1 but if you can, please fix the last grammar comment. Thank you for doing this!

rebased onto df370a8fb24470b4255208364c59a79bbe362766

rebased onto 78d02be25f1bbaf02c97f55596b9421def1732e4

@mprahl Fixed. Thanks :) This PR is also rebased on latest master branch.

Pull-Request has been merged by cqi

Metadata