Changeset 00ae33 in git for doc/STYLEGUIDE

Timestamp:

May 18, 1998, 3:53:36 PM (25 years ago)

Author:

Jens Schmidt <schmidt@…>

Branches:

(u'spielwiese', '8e0ad00ce244dfd0756200662572aef8402f13d5')

Children:

1e76d7acd403cad88e14af9ac03759b6e6bbb823

Parents:

37897bddb725ebe55f45042bf267b1af7a635663

Message:

	* STYLEGUIDE: doc fix


git-svn-id: file:///usr/local/Singular/svn/trunk@1819 2c84dea3-7e68-4137-9b89-c4e89433aadc

File:

• doc/STYLEGUIDE (modified) (4 diffs)

doc/STYLEGUIDE

@@ -49 +49 @@
 + Email Adressen in @email{...} notieren, URL's in @url{...}
 
+
 * Notationen *
 ==============
@@ -76 +77 @@
     TRACE
 
-+ Die Funktionsweise von Funktionen (vor allem im Kapitel "Functions")
-  wird in der dritten Person beschrieben. Statt "will be" wird "is"
-  verwendet:
-    vdim: returns the vector space dimension ....
++ Die Funktionsweise von Funktionen (vor allem im Kapitel "Functions", aber
+  auch z.B. Kommandozeilen-Optionen, etc.)  wird in der dritten Person
+  beschrieben. Sie fangen mit einem Kleinbuchstaben an und schliessen mit
+  einem Punkt.  Bitte vollstaendige Saetze formulieren.
+  
+    npars: returns the number of ring parameters.
+
+  Statt "will be" wird "is" verwendet:
+
     the result is a standard basis (statt will be a standard basis)
+
 
 * Schreibweisen *
@@ -142 +149 @@
   werden. (Sonst bekommt man "overfull hbox"-Meldungen um die Ohren
   geschmissen.)
-
-+ Kommando-Beschreibungen (Purpose:) fangen mit einem Kleinbuchstaben an,
-  sind in der dritten Person Singular gehalten und schliessen mit einem
-  Punkt.  Vollstaendige Saetze formulieren.  Beispiel:
-
-  Purpose:  returns the number of ring parameters.
 
 + Hilfe-Texte in Libraries: keine TAB's verwenden
@@ -203 +204 @@
 
 ------------------------------------------------------------
-$Id: STYLEGUIDE,v 1.5 1998-05-18 13:36:31 schmidt Exp $
+$Id: STYLEGUIDE,v 1.6 1998-05-18 13:53:36 schmidt Exp $
 ------------------------------------------------------------