Opened 6 months ago

Closed 6 months ago

#6943 task closed fixed (fixed)

projects/core/howto/udp.rst should be properly formatted

Reported by: hawkowl Owned by:
Priority: normal Milestone: Lore to Sphinx
Component: core Keywords: documentation
Cc: Branch: branches/udp-docs-format-6943
(diff, github, buildbot, log)
Author: hawkowl Launchpad Bug:

Description

Lore2Sphinx outputs rST which is functionally correct, but isn't pretty in source. There's formatting errors which will need to be fixed up manually.

I wrote a small script that tells me all of the branches with changes for the old Lore sources. As the procedure to port these is "run lore to sphinx on them", we can't touch them until those branches are merged without getting merge conflicts.

docs/projects/core/howto/udp.rst is not one of these conflicting files, so this ticket is about formatting it properly.

Change History (4)

comment:1 Changed 6 months ago by hawkowl

  • Author set to hawkowl
  • Branch set to branches/udp-docs-format-6943

(In [41526]) Branching to udp-docs-format-6943.

comment:2 Changed 6 months ago by hawkowl

  • Keywords review added
  • Owner hawkowl deleted

Putting this up to review.

This is purely formatting changes - things like semantic newlines, spaces where they shouldn't be and rSTification where needed.

comment:3 Changed 6 months ago by exarkun

  • Keywords review removed

Thanks! Just a couple minor points:

  1. There's still quite a few lines with trailing whitespace. Please clean those up as well.
  2. reST renders -- as en dash. In the sentence A connected UDP socket is slightly different from a standard one -- it can only send and receive datagrams to/from a single address, but this does not\

in any way imply a connection. en dash is clearly incorrect. So was hyphen, before, so this isn't exactly any worse. Considering you're changing the punctuation anyway, though, consider changing it to a colon or a period.

Please merge after fixing those.

comment:4 Changed 6 months ago by hawkowl

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

(In [41536]) Merge udp-docs-format-6943: projects/core/howto/udp.rst should be properly formatted

Author: hawkowl
Reviewer: exarkun
Fixes: #6943

Minor documentation changes, including reformatting to semantic newlines and minor grammar fixes.

Note: See TracTickets for help on using tickets.