Ticket #4949 enhancement closed fixed

Opened 2 years ago

Last modified 23 months ago

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

versioned.patch Download (1.0 KB) - added by thijs 23 months ago.
versioned.2.patch Download (2.7 KB) - added by thijs 23 months ago.

Change History

1

  Changed 2 years ago by khorn

  • keywords documentation added

2

  Changed 2 years ago by thijs

  • status changed from new to assigned
  • owner set to thijs

3

in reply to: ↑ description   Changed 23 months ago by thijs

  • cc thijs added
  • owner thijs deleted
  • status changed from assigned to new
  • keywords documentation, review added; documentation removed

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 23 months ago by thijs

4

  Changed 23 months ago by jesstess

  • cc jesstess added
  • owner set to thijs
  • keywords documentation added; documentation, review removed

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 23 months ago by thijs

5

  Changed 23 months ago by thijs

  • status changed from new to closed
  • resolution set to fixed

(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.