Groups > linux.debian.maint.python > #15287

Wiki "AppStyleGuide": Not clear to new users

Path	csiph.com!1.us.feeder.erje.net!3.us.feeder.erje.net!2.eu.feeder.erje.net!3.eu.feeder.erje.net!feeder.erje.net!news.in-chemnitz.de!news2.arglkargh.de!news.mixmin.net!eternal-september.org!feeder2.eternal-september.org!eternal-september.org!fu-berlin.de!bofh.it!news.nic.it!robomod
From	c.buhtz@posteo.jp
Newsgroups	linux.debian.maint.python
Subject	Wiki "AppStyleGuide": Not clear to new users
Date	Thu, 02 Nov 2023 04:20:02 +0100
Message-ID	<Hvwps-2uQp-5@gated-at.bofh.it> (permalink)
X-Mailbox-Line	From debian-python-request@lists.debian.org Thu Nov 2 03:15:37 2023
Old-Return-Path	<c.buhtz@posteo.jp>
X-Amavis-Spam-Status	No, score=-10.51 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, LDO_WHITELIST=-5, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H5=-1, RCVD_IN_MSPIKE_WL=-0.01] autolearn=ham autolearn_force=no
X-Policyd-Weight	using cached result; rate:hard: -5.5
MIME-Version	1.0
Content-Type	text/plain; charset=US-ASCII; format=flowed
Content-Transfer-Encoding	7bit
X-Mailing-List	<debian-python@lists.debian.org> archive/latest/21226
List-ID	<debian-python.lists.debian.org>
List-URL	<https://lists.debian.org/debian-python/>
List-Archive	https://lists.debian.org/msgid-search/8a5273636947b187117ec08e804bc596@posteo.de
Approved	robomod@news.nic.it
Lines	20
Organization	linux.* mail to news gateway
Sender	robomod@news.nic.it
X-Original-Date	Thu, 02 Nov 2023 03:15:12 +0000
X-Original-Message-ID	<8a5273636947b187117ec08e804bc596@posteo.de>
Xref	csiph.com linux.debian.maint.python:15287

Show key headers only | View raw

Hello,

related to https://wiki.debian.org/Python/AppStyleGuide

There are several problems with that page.

It is to short to be a single instance. Just add it as a section to the 
"LibraryStyleGuide" and rename it to "StyleGuide". This would help 
against to much fractioning of the documentation.

There are some codeblocks in that page. They lack of description and 
introduction. It is totally unclear in which language that code is. No 
shebang in the beginning. Is this bash? Which file should contain that 
code?

The date of that wiki page is from year 2014. So maybe its content is 
outdated and not relevant anymore?

Kind
Christian Buhtz

Back to linux.debian.maint.python | Previous | Next | Find similar | Unroll thread

Thread

Wiki "AppStyleGuide": Not clear to new users c.buhtz@posteo.jp - 2023-11-02 04:20 +0100

csiph-web