Ticket #4274 enhancement closed fixed

Opened 4 years ago

Last modified 4 years ago

Broken links in UDP howto

Reported by: Screwtape Owned by: jesstess
Priority: normal Milestone:
Component: core Keywords: documentation, easy
Cc: jesstess, thijs Branch: branches/broken-udp-links-4274
(diff, github, buildbot, log)
Author: jesstess Launchpad Bug:

Description

"frostschutz" just dropped by #twisted to mention that in the  UDP How To, there are links to twisted.internet.protocol.DatagramProtocol.startProtocol and twisted.internet.protocol.DatagramProtocol.stopProtocol that actually lead to 404 errors.

It turns out, those methods are actually defined on AbstractDatagramProtocol so I'm not sure what the links should actually look like.

Change History

1

Changed 4 years ago by jesstess

  • owner changed from glyph to jesstess

2

Changed 4 years ago by jesstess

  • branch set to branches/broken-udp-links-4274
  • branch_author set to jesstess

(In [28539]) Branching to 'broken-udp-links-4274'

3

Changed 4 years ago by jesstess

(In [28540]) Fix startProtocol and stopProtocol links and remove trailing whitespace.

refs #4274

4

Changed 4 years ago by jesstess

  • keywords documentation, review added; documentation removed
  • cc jesstess added
  • owner jesstess deleted

5

Changed 4 years ago by thijs

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

There are some more code references to class names in the document that could use a <code>.

6

Changed 4 years ago by jesstess

(In [28615]) Add more code markup, spellcheck, be a little more precise terminology-wise in some places, etc.

refs #4274

7

Changed 4 years ago by jesstess

  • owner jesstess deleted
  • keywords documentation, review, easy added; documentation removed

8

Changed 4 years ago by TimAllen

  • owner set to TimAllen

9

Changed 4 years ago by TimAllen

  • keywords review, removed
  • owner changed from TimAllen to jesstess

Thanks for doing the spell-checking and grammar editing, jesstess — it does read much more nicely now. The only edit I think is negative is line 83 where you avoided a trailing preposition: I think "the address the socket is 'connected' to" flows better than "the address to which the socket is 'connected'".

I'm prepared to call that a personal style issue, though. +1 for merging with or without that change.

10

Changed 4 years ago by jesstess

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

(In [28656]) Merge broken-udp-links-4274

Author: jesstess Reviewers: thijs, TimAllen Fixes: #4274

Fix broken API links, add markup, spellcheck, and rework some phrasing.

Note: See TracTickets for help on using tickets.