Opened 3 years ago

Closed 3 years ago

#4949 enhancement closed fixed (fixed)

Fix various issues with "meta" docs in `projects/core/howto`

Reported by: khorn Owned by: thijs
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: thijs, jesstess Branch:
Author: Launchpad Bug:

Description

various issues:

  • debug-with-emacs: pokey is missing, reinstate him
  • glossary: Consider is the removal of the (currently broken) link from the "Spread" entry title: We could keep it as a link to core/howto/pb.html, which is titled "Overview Of Twisted Spread" and seems like a good place to send readers who want to learn more about Spread.
  • upgrading: Looks good, but I noticed that under "Rebuild: Loading New Code Without Restarting", the API link is being removed from the first mention of Versioned (seemingly because it was broken?) But the second appearance of Versioned in that section has a working link to http://twistedmatrix.com/documents/current/api/twisted.persisted.styles.Versioned.html; It seems like the first mention should link to the same place. Later mentions of both rebuild and Versioned aren't links, but that seems to be on purpose. (I'm guessing the pattern is that the first mention in a paragraph is a link and the rest aren't?)

Attachments (2)

versioned.patch (992 bytes) - added by thijs 3 years ago.
versioned.2.patch (2.7 KB) - added by thijs 3 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 3 years ago by khorn

  • Keywords documentation added

comment:2 Changed 3 years ago by thijs

  • Owner set to thijs
  • Status changed from new to assigned

comment:3 in reply to: ↑ description Changed 3 years ago by thijs

  • Cc thijs added
  • Keywords review added
  • Owner thijs deleted
  • Status changed from assigned to new

Replying to khorn:

various issues:

  • debug-with-emacs: pokey is missing, reinstate him

I can see the image in my local version as well as online?

  • glossary: Consider is the removal of the (currently broken) link from the "Spread" entry title: We could keep it as a link to core/howto/pb.html, which is titled "Overview Of Twisted Spread" and seems like a good place to send readers who want to learn more about Spread.

Looks like this was fixed in r31099.

  • upgrading: Looks good, but I noticed that under "Rebuild: Loading New Code Without Restarting", the API link is being removed from the first mention of Versioned (seemingly because it was broken?) But the second appearance of Versioned in that section has a working link to http://twistedmatrix.com/documents/current/api/twisted.persisted.styles.Versioned.html; It seems like the first mention should link to the same place. Later mentions of both rebuild and Versioned aren't links, but that seems to be on purpose. (I'm guessing the pattern is that the first mention in a paragraph is a link and the rest aren't?)

Fixed in attached patch.

Changed 3 years ago by thijs

comment:4 Changed 3 years ago by jesstess

  • Cc jesstess added
  • Keywords review removed
  • Owner set to thijs

Thanks for all your work on these documentation tickets, thijs.

Your changes look good to ship. While you're in that file, it'd be great if you could correct a few spelling errors:

  • accomodate ==> accommodate
  • compatiblity ==> compatibility
  • compability ==> compatibility

Other than that, looks great, please merge.

Changed 3 years ago by thijs

comment:5 Changed 3 years ago by thijs

  • Resolution set to fixed
  • Status changed from new to closed

(In [32228]) Apply versioned.2.patch: Add additional link for t.persisted.styles.Versioned and correct some typos.

Author: thijs
Reviewer: jesstess
Fixes: #4949

Note: See TracTickets for help on using tickets.