Documentation for fractions module needs work

[mdickinson]

BPO	3197
Nosy	@mdickinson
Files	fractions_doc.patch: Documentation update for fractions module fractions_doc2.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/mdickinson'
closed_at = <Date 2008-06-27.17:04:38.708>
created_at = <Date 2008-06-25.11:22:22.039>
labels = ['docs']
title = 'Documentation for fractions module needs work'
updated_at = <Date 2008-06-27.17:04:38.707>
user = 'https://github.com/mdickinson'

bugs.python.org fields:

activity = <Date 2008-06-27.17:04:38.707>
actor = 'mark.dickinson'
assignee = 'mark.dickinson'
closed = True
closed_date = <Date 2008-06-27.17:04:38.708>
closer = 'mark.dickinson'
components = ['Documentation']
creation = <Date 2008-06-25.11:22:22.039>
creator = 'mark.dickinson'
dependencies = []
files = ['10728', '10750']
hgrepos = []
issue_num = 3197
keywords = ['patch']
message_count = 5.0
messages = ['68724', '68734', '68824', '68833', '68835']
nosy_count = 2.0
nosy_names = ['mark.dickinson', 'jyasskin']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue3197'
versions = ['Python 2.6', 'Python 3.0', 'Python 2.7']

[mdickinson]

The documentation for the fractions module needs some rewriting---it
contains minor inaccuracies, outdated statements (e.g. the regex is
incomplete), and there are places that could use some clarification (e.g.
the description of __round__).

I plan to take care of this in the next few days, unless anyone else wants
to have a look. I'm making an issue of it so that it doesn't get
forgotten.

[mdickinson]

Here's a proposed new draft of the fractions documentation for 2.6.
Apart from wording changes, it:

• removes documentation for __floor__, __ceil__ and __round__, since
  those no longer exist in 2.6

• describes construction from a decimal string; e.g. Fraction('1.23')

• gives the acceptable string inputs using BNF rather than via a regex.

Jeffrey: does this look reasonable?

[mdickinson]

Here's an updated doc patch; it fixes an indentation issue in the
previous patch, and adds documentation for the exported gcd function.

[jyasskin]

[sign] integer '.' [fraction] | [sign] ['.'] fraction

Shouldn't make the second '.' optional or this will match plain
numerators too.

Otherwise, looks good. Thanks for fixing this!

[mdickinson]

Shouldn't make the second '.' optional or this will match plain
numerators too.

Thanks. Fixed, and committed in r64561 (trunk), and r64562 (py3k).