Opened 8 years ago

Closed 8 years ago

#14139 closed enhancement (fixed)

doc of prandom.py

Reported by: chapoton Owned by: tbd
Priority: major Milestone: sage-5.8
Component: misc Keywords: documentation
Cc: Merged in: sage-5.8.beta1
Authors: Frédéric Chapoton, Travis Scrimshaw Reviewers: Frédéric Chapoton
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

correct bad formattings in the prandom.py documentation

Attachments (1)

trac-14139-type-doc-choice.patch​ (11.0 KB) - added by chapoton 8 years ago.

Download all attachments as: .zip

Change History (10)

comment:1 Changed 8 years ago by chapoton

  • Summary changed from doc of choice function to doc of prandom.py

comment:2 Changed 8 years ago by chapoton

  • Component changed from PLEASE CHANGE to misc
  • Keywords documentation added
  • Status changed from new to needs_review

comment:3 Changed 8 years ago by chapoton

  • Authors set to Frédéric Chapoton

comment:4 Changed 8 years ago by tscrim

Hey Frederic,

For those blocks which are complete sentences (lines 23 and 33), I think it would be better to have a whitespace before the double colon :: since this would cause a colon to be outputted in the doc (if it was ever built, but that won't happen until the file is linked).

Part of me would like to see this file brought up to ReST standards while we are going through its doc, but I don't know if we will ever link this file into the doc. If you don't think it's worthwhile, you can set this to positive review after you put in the aforementioned whitespace.

Thanks,
Travis

Changed 8 years ago by chapoton

comment:5 Changed 8 years ago by chapoton

I have added one of the required whitespace, and remove a dot before the other "::"

I have also added a few "r" to prepare for Rest markup.

comment:6 Changed 8 years ago by chapoton

  • Status changed from needs_review to positive_review

Given Travis comment above, I set that simple and harmless patch to positive review.

comment:7 Changed 8 years ago by jdemeyer

  • Reviewers set to Frédéric Chapoton

comment:8 Changed 8 years ago by tscrim

  • Authors changed from Frédéric Chapoton to Frédéric Chapoton, Travis Scrimshaw

Sorry I forgot to put myself as a reviewer.

comment:9 Changed 8 years ago by jdemeyer

  • Merged in set to sage-5.8.beta1
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.