Update all of the development documentation

Review Request #404 — Created Jan. 5, 2021 and submitted

grim
pidgin/pidgin
default
ee68dc5cf079
pidgin
Add documentation for using our repos and how to contribute to them.

Built the docs locally and verified they look decent.

Description From Last Updated

Change "setup" to "set up" (semantics of how it's used here).

rekkanoryorekkanoryo

Lose the "so" at the end of this line. Reads better.

rekkanoryorekkanoryo

Might read better if rephrased something like "Do not put anything after the <code>=</code> so that Mercurial will look in …

rekkanoryorekkanoryo

Change "as well as" to "and".

rekkanoryorekkanoryo

Lose the comma here.

rekkanoryorekkanoryo

Should be "Review Board" for consistency with the rest of the text.

rekkanoryorekkanoryo

I'd suggest something more like: Once you have an account and have logged into our Review Board site, you can …

rekkanoryorekkanoryo

Lose the comma

rekkanoryorekkanoryo

Do you actually mean to say dry-run here? The rest of this paragraph talks about the actual rebase.

rekkanoryorekkanoryo

Lose "back"

rekkanoryorekkanoryo

Lose the second "just"

rekkanoryorekkanoryo

I missed this in the initial review, but the comma after "branching point" shouldn't be here either.

rekkanoryorekkanoryo
rekkanoryo
  1. 
      
  2. Change "setup" to "set up" (semantics of how it's used here).

  3. Lose the "so" at the end of this line. Reads better.

  4. I assume the mismatched indent here is for proper formatting behavior?

    1. Correct, <codelisting> keeps white space, that said I can probably put it at the end of the text, but if I indent it then that white space will be in the code listing.

  5. Might read better if rephrased something like "Do not put anything after the <code>=</code> so that Mercurial will look in the default places for the extensions."

  6. Change "as well as" to "and".

  7. Lose the comma here.

  8. Should be "Review Board" for consistency with the rest of the text.

  9. The comma here isn't strictly necessary. Not opening an issue here because I can't decide if it reads better with or without the comma.

  10. doc/reference/libpurple/code_contributions.xml (Diff revision 1)
     
     
     
     
     
     
     
     
     

    I'd suggest something more like:

    Once you have an account and have logged into our Review Board site, you can begin using RBTools. In your shell, navigate to a Mercurial clone of one of the Pidgin or purple-related projects, then run the <code>rbt login</code> command. You should only need to do this once, unless you change your password or have run the <code>rbt logout</code> command.

  11. Lose the comma

  12. Do you actually mean to say dry-run here? The rest of this paragraph talks about the actual rebase.

    1. Yes, it's an argument to the command right before this and is how you "preview" the rebase.

  13. doc/reference/libpurple/mercurial.xml (Diff revision 1)
     
     

    Lose the second "just"

  14. 
      
grim
rekkanoryo
  1. Looks good. After the last change I note below, should be good to bo.

    1. I, of course, meant "good to go" above.

  2. I missed this in the initial review, but the comma after "branching point" shouldn't be here either.

  3. 
      
grim
rekkanoryo
  1. Ship It!
  2. 
      
grim
Review request changed

Status: Closed (submitted)

Change Summary:

Had to append an extra </para> that we somehow missed, but aside from that everything was exact to what was seen here.

Loading...