Path: csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!feeder.erje.net!eu.feeder.erje.net!news.stack.nl!newsfeed.xs4all.nl!newsfeed1.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail Return-Path: X-Original-To: python-list@python.org Delivered-To: python-list@mail.python.org X-Spam-Status: OK 0.006 X-Spam-Evidence: '*H*': 0.99; '*S*': 0.00; 'sufficient': 0.05; 'back.': 0.09; 'received:80.91': 0.09; 'received:80.91.229': 0.09; 'received:gmane.org': 0.09; 'received:list': 0.09; 'api': 0.11; "wouldn't": 0.14; '23,': 0.16; 'behaviour.': 0.16; 'from:addr:behnel.de': 0.16; 'from:addr:stefan_ml': 0.16; 'from:name:stefan behnel': 0.16; 'naming': 0.16; 'rarely': 0.16; 'received:80.91.229.3': 0.16; 'received:plane.gmane.org': 0.16; 'recently.': 0.16; 'renaming': 0.16; 'wrote:': 0.18; 'module': 0.19; 'stefan': 0.19; 'not,': 0.20; '>>>': 0.22; 'header:User- Agent:1': 0.23; 'case.': 0.24; "haven't": 0.24; 'source': 0.25; 'pass': 0.26; 'values': 0.27; 'header:X-Complaints-To:1': 0.27; 'header:In-Reply-To:1': 0.27; 'function': 0.29; 'correct': 0.29; 'am,': 0.29; 'generally': 0.29; 'comments': 0.31; 'sep': 0.31; 'probably': 0.32; 'url:python': 0.33; 'maybe': 0.34; 'received:84': 0.35; 'but': 0.35; 'url:org': 0.36; 'should': 0.36; 'two': 0.37; 'url:library': 0.38; 'to:addr:python-list': 0.38; 'rather': 0.38; 'expect': 0.39; 'sure': 0.39; 'to:addr:python.org': 0.39; 'enough': 0.39; 'received:org': 0.40; 'even': 0.60; 'read': 0.60; 'easy': 0.60; 'ian': 0.60; 'negative': 0.60; 'url:5': 0.61; 'url:3': 0.61; 'further': 0.61; 'first': 0.61; 'making': 0.63; 'kind': 0.63; 'believe': 0.68; 'date,': 0.68; 'debate': 0.68; 'irrelevant': 0.84 X-Injected-Via-Gmane: http://gmane.org/ To: python-list@python.org From: Stefan Behnel Subject: Re: GCD in Fractions Date: Tue, 23 Sep 2014 20:09:23 +0200 References: <54216c8e$0$29966$c3e8da3$5496439d@news.astraweb.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-Gmane-NNTP-Posting-Host: dslb-084-056-021-004.084.056.pools.vodafone-ip.de User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.1.1 In-Reply-To: X-BeenThere: python-list@python.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: General discussion list for the Python programming language List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Newsgroups: comp.lang.python Message-ID: Lines: 29 NNTP-Posting-Host: 2001:888:2000:d::a6 X-Trace: 1411495781 news.xs4all.nl 2860 [2001:888:2000:d::a6]:55413 X-Complaints-To: abuse@xs4all.nl Xref: csiph.com comp.lang.python:78239 Ian Kelly schrieb am 23.09.2014 um 19:39: > On Tue, Sep 23, 2014 at 11:26 AM, Stefan Behnel wrote: >> Wolfgang Maier schrieb am 23.09.2014 um 18:38: >>> While at first I thought this to be a rather irrelevant debate over module >>> private vs public naming conventions, I now think the OP is probably right >>> and renaming fractions.gcd to fractions._gcd may be a good idea. >> >> Making a public API private is rarely a good idea. It should be enough in >> this case to document the behaviour. >> >> And, believe it or not, it actually is documented: >> >> https://docs.python.org/3.5/library/fractions.html#fractions.gcd > > I don't think documentation is sufficient in this case. This is the > kind of thing though that is easy to forget about if you haven't read > the documentation recently. And with a function like gcd, one > generally wouldn't expect to *need* to read the documentation. Interesting. I would definitely consult the documentation first thing if I were considering to pass negative values into a gcd function - into any implementation, even if I had been the very author myself, just two months back. I might even take a look at the source to make sure the docs are correct and up to date, and to look for comments that give further insights. But maybe that's just me. Stefan