Opened 6 years ago

Closed 6 years ago

#6406 defect closed fixed (fixed)

Spelling mistakes in trial.xhtml howto

Reported by: Itamar Turner-Trauring Owned by: Richard Wall
Priority: normal Milestone:
Component: core Keywords: documentation gsoc easy
Cc: Branch: branches/trial-howto-spelling-6406
branch-diff, diff-cov, branch-cov, buildbot
Author: rwall

Description

doc/core/howto/trial.xhtml has a couple of spelling mistakes, at least: "particulary" and "mutiply".

Attachments (2)

twisted-doc-core-howto-trial.patch (1.4 KB) - added by nothung 6 years ago.
Corrected misspellings in doc/core/howto/trial.xhtml for words "multiply", "particularly", and "possible"
twisted-doc-core-howto-trial_fixed.patch (10.8 KB) - added by Łukasz 6 years ago.
Corrected issues mentioned by RichardW

Download all attachments as: .zip

Change History (14)

comment:1 Changed 6 years ago by nothung

Owner: set to nothung
Status: newassigned

Changed 6 years ago by nothung

Corrected misspellings in doc/core/howto/trial.xhtml for words "multiply", "particularly", and "possible"

comment:2 Changed 6 years ago by nothung

Keywords: gsoc review added
Owner: nothung deleted
Status: assignednew

comment:3 Changed 6 years ago by Richard Wall

Owner: set to Richard Wall
Status: newassigned

reviewing...

comment:4 Changed 6 years ago by Richard Wall

Keywords: review removed
Owner: changed from Richard Wall to nothung
Status: assignednew

Code Review:

Thanks nothung for correcting those spelling mistakes. It looks like you found them all.

Please address or answer the following points:

  1. Add a .doc news file. All patches should include a news file. This is a documentation change so it should have a .doc extension and a short description of the change.

https://twistedmatrix.com/trac/wiki/ReviewProcess#Newsfiles

  1. There are a few sentences in that document that I either don't make sense or sound unprofessional or which might be difficult for non-english speakers to interpret.

Read through the document and fix at least the grammar and punctuation errors.

Raise another ticket for general improvements to the trial howto document.

Here are some things I noticed as I read the document. Fix at least the ones marked with an X

  1. "There is also a ton of information"
  2. "cover a networking code" X
  3. "get set up"
  4. "get these both done"
  5. "you're in business"
  6. "(though your files are probably not in /tmp" - missing closing bracket X
  7. "How to interpret this output?"
  8. "Trial create a _" X
  9. "is a copy of test_base_1" X
  10. "used in tests methods" X
  11. "Much cleaner, no?"
  12. "If you run the above, you'll see"
  13. "let that exception go by as TypeError is already" X
  14. "We'll now create a custom protocol to invoke our class from within a telnet-like session"
  15. "it helps a lot to be comfortable with the"
  16. "The server (once again, see below) hands the work off to" X
  17. "If you run this test (trial calculus.test.test_remote_1), everything should be fine"
  18. "Of course, what we build is not particulary useful for now :

we'll now build a client to our server" X

  1. "Thus, every callLater calls in the protocol will finish" X
  2. "that simulates and advance in time" X
  3. "when everything went fine"
  4. "people that want" X
  5. "avoid that like the plague"
  6. "Recent versions of trial will fail loudly if you remove the stopListening call, which is good."
  7. "tearDown will called in any case" X
  8. "expect that every objects you" X
  9. "This remove the need" X
  10. "Generally an user" X
  11. "I have this strange problem on my crappy network environment"
  12. "There are different kind of measures" X
  13. "for every modules used" X
  14. "the number of times you went through during the tests" X

Once you've addressed those points, please submit another patch for review.

-RichardW.

comment:5 Changed 6 years ago by Jean-Paul Calderone

Add a .doc news file. All patches should include a news file. This is a documentation change so it should have a .doc extension and a short description of the change.

I think typo fixes can be a .misc file.

comment:6 Changed 6 years ago by Richard Wall

Keywords: easy added

Changed 6 years ago by Łukasz

Corrected issues mentioned by RichardW

comment:7 Changed 6 years ago by Łukasz

Corrected issues mentioned by RichardW.

comment:8 Changed 6 years ago by Richard Wall

Author: rwall
Branch: branches/trial-howto-spelling-6406

(In [40060]) Branching to 'trial-howto-spelling-6406'

comment:9 Changed 6 years ago by Richard Wall

(In [40062]) Apply twisted-doc-core-howto-trial_fixed.patch from phoenix. Refs #6406

comment:10 Changed 6 years ago by Łukasz

Keywords: review added
Owner: nothung deleted

comment:11 Changed 6 years ago by Richard Wall

Keywords: review removed
Owner: set to Richard Wall
Status: newassigned

Replying to phoenix:

Corrected issues mentioned by RichardW.

Thanks pheonix, Chris, and holger,

The build results look good and I agree with almost all your changes.

I changed a couple of things in r40064.

Added a news file r40065.

So I'll merge it.

Thanks.

-RichardW.

comment:12 Changed 6 years ago by Richard Wall

Resolution: fixed
Status: assignedclosed

(In [40067]) Merge trial-howto-spelling-6406

Authors: nothung,phoenix,PyWebEU Reviewer: rwall Fixes: #6406

Spelling and grammar corrections in the trial howto document.

Note: See TracTickets for help on using tickets.