473,602 Members | 2,767 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

good style guides for python-style documentation ?

(reposted from doc-sig, which seems to be mostly dead
these days).

over at the pytut wiki, "carndt" asked:

Are there any guidelines about conventions concerning
punctuation, text styles and language style (e.g. how
to address the reader)?

any suggestions from this list ?

</F>

Apr 6 '06 #1
4 1335
> (reposted from doc-sig, which seems to be mostly dead
these days).

over at the pytut wiki, "carndt" asked:

Are there any guidelines about conventions concerning
punctuation, text styles and language style (e.g. how
to address the reader)?

any suggestions from this list ?

</F>


Well there's:

PEP 8 -- Style Guide for Python Code
http://www.python.org/dev/peps/pep-0008/
But I presume you already know that one. It covers doc strings some,
but not general documentation. A how-to on documenting would be nice.

Cheers,
Ron
Apr 6 '06 #2
Fredrik Lundh wrote:
(reposted from doc-sig, which seems to be mostly dead
these days).

over at the pytut wiki, "carndt" asked:

Are there any guidelines about conventions concerning
punctuation, text styles and language style (e.g. how
to address the reader)?

any suggestions from this list ?


Just for fun one day, I extracted what I thought were the main points
from the PEP and made a website for it:

http://www.johnjsal.devisland.net/styleguide.html
Apr 6 '06 #3
Fredrik Lundh wrote:
(reposted from doc-sig, which seems to be mostly dead
these days).

over at the pytut wiki, "carndt" asked:

Are there any guidelines about conventions concerning
punctuation, text styles and language style (e.g. how
to address the reader)?

any suggestions from this list ?

</F>


Documenting Python http://docs.python.org/dev/doc/style-guide.html
recommends Apple Publications Style Guide:
http://developer.apple.com/reference...fund-date.html

GNOME Documentation Style Guide is also quite useful:
http://developer.gnome.org/documents/style-guide/ .

Ziga

Apr 6 '06 #4

Fredrik Lundh wrote:
(reposted from doc-sig, which seems to be mostly dead
these days).

over at the pytut wiki, "carndt" asked:

Are there any guidelines about conventions concerning
punctuation, text styles and language style (e.g. how
to address the reader)?

any suggestions from this list ?

</F>

Hi
You can read the document given in link:
Documenting Python http://docs.python.org/dev/doc/style-guide.html
Bye

Apr 7 '06 #5

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

4
1412
by: Stephanie_Stowe | last post by:
I am an experienced ASp (classic) and VB developer. My organization will be moving to DOTNET. I need to get started figuring out the framework, C# and ASP.NET. (Yeah, yeah I am a little late.) The web and MS site is *awash* with info. Do you guys have a good starting web site or book or something that you can particularly recommend from the vantage of an experienced programmer, rather than a complete newbie? Thanks S
7
5254
by: tada991 | last post by:
Hello Everyone, I just purchased Visual Studio .Net Architect 2003 and want to know what's a good book for begginers to start with. I know nothing about programming whatsoever, but I do have a desire to learn- as obvious with this purchase. So please let me know where I can start and thanks. Also, what newsgroup should I post my queries to?
11
9424
by: Angel Todorov | last post by:
Hello, sometimes I get a strange error from postgresql when I try to connect using ssl to the server: LOG: parse_hba: invalid syntax in pg_hba.conf file at line 46, token "hostssl" FATAL: Missing or erroneous pg_hba.conf file, see postmaster log for details The contents of the pg_hba.conf file are
2
1833
by: J.Marsch | last post by:
Ok, so here's a problem you probably don't see every day: We are building an application that must run in a browser, but we need to do some things client-side that would be rather difficult to pull off with the usual browser-side scripting (javascript etc). It's been decided that this one, complicated function will be implemented by hosting a Winform in the browser. Now, this winform contains an ActiveX control (an HTML editor).
10
2164
by: Harley | last post by:
Hello, I was VERY blessed with a Christmas gift of visual studio .net from a man I hardly know who had heard of my plans of software developement. So I am probably the only person in the world who actualy has this great IDE and don't even know vb.net (or c sharp etc.). I have some prior exposure to simple scripting language such as javascript and I understand data types etc. (basic programming concepts and procedures) but I don't have any...
1
1101
by: Sougato Das | last post by:
Does anyone know any good places for information on sockets programming using VB.NET. I know VB.NET fairly well, but I know very little about sockets. Thanks.
29
3640
by: seberino | last post by:
I'm trying to move beyond Emacs/Vim/Kate and was wondering if Eclipse is better and if it is the *best* IDE for Python. Should I leave Emacs and do Python coding in Eclipse? Chris
4
1512
by: mechanicfem | last post by:
Lately I've been trying to learn about new stuff in c99 - today's topic was/is variable length arrays. As well as asking here, I've been 'doing the rounds' via Google, and recently I found this article: http://www.informit.com/guides/content.asp?g=cplusplus&seqNum=215 It didn't help me much re my earlier question about using
6
2237
by: WJRutledge | last post by:
Just like the subject says, I'm interested in taking up PHP and would like to know if anyone knows of any books that are a must have. I know there are tons of books out there on every language, but I'm sure some are much better than others. I'm mainly looking for a beginners book that also had advanced content too, but if that doesn't exist, then just an excellent beginners book would be fine too. Thanks in advance for any information you...
2
1557
by: Humakt | last post by:
Does anyone knows good guides about threads for C++? Preferably with example code. I'm using win32 + DirectX for chessprogram and I need thread for computer player (so that program doesn't go unresponsive while AI ponders its next move).
0
7993
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
7920
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
8401
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
8404
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
0
8268
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
6730
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
0
5440
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
3900
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
0
3944
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.