[Rsiena-commits] r123 - in pkg: RSiena RSiena/man RSienaTest RSienaTest/doc RSienaTest/man

[noreply at r-forge.r-project.org]

Author: ripleyrm
Date: 2010-10-13 21:55:33 +0200 (Wed, 13 Oct 2010)
New Revision: 123

Modified:
   pkg/RSiena/DESCRIPTION
   pkg/RSiena/changeLog
   pkg/RSiena/man/RSiena-package.Rd
   pkg/RSienaTest/DESCRIPTION
   pkg/RSienaTest/changeLog
   pkg/RSienaTest/doc/RSienaDeveloper.tex
   pkg/RSienaTest/man/RSiena-package.Rd
Log:
Updated documentation

Modified: pkg/RSiena/DESCRIPTION
===================================================================
--- pkg/RSiena/DESCRIPTION	2010-10-09 10:11:47 UTC (rev 122)
+++ pkg/RSiena/DESCRIPTION	2010-10-13 19:55:33 UTC (rev 123)
@@ -1,8 +1,8 @@
 Package: RSiena
 Type: Package
 Title: Siena - Simulation Investigation for Empirical Network Analysis
-Version: 1.0.11.122
-Date: 2010-10-09
+Version: 1.0.11.123
+Date: 2010-10-13
 Author: Various
 Depends: R (>= 2.9.0), xtable
 Imports: Matrix

Modified: pkg/RSiena/changeLog
===================================================================
--- pkg/RSiena/changeLog	2010-10-09 10:11:47 UTC (rev 122)
+++ pkg/RSiena/changeLog	2010-10-13 19:55:33 UTC (rev 123)
@@ -1,3 +1,7 @@
+2010-10-13 R-forge revision 123 RSienaTest only
+
+	* doc/RSienaDeveloper.tex: added details about change logs etc
+
 2010-10-09 R-forge revision 122
 
 	* src/siena07models.cpp: corrected loop for return of MH

Modified: pkg/RSiena/man/RSiena-package.Rd
===================================================================
--- pkg/RSiena/man/RSiena-package.Rd	2010-10-09 10:11:47 UTC (rev 122)
+++ pkg/RSiena/man/RSiena-package.Rd	2010-10-13 19:55:33 UTC (rev 123)
@@ -30,8 +30,8 @@
 \tabular{ll}{
 Package: \tab RSiena\cr
 Type: \tab Package\cr
-Version: \tab 1.0.11.122\cr
-Date: \tab 2010-10-09\cr
+Version: \tab 1.0.11.123\cr
+Date: \tab 2010-10-13\cr
 License: \tab GPL-2 \cr
 LazyLoad: \tab yes\cr
 }

Modified: pkg/RSienaTest/DESCRIPTION
===================================================================
--- pkg/RSienaTest/DESCRIPTION	2010-10-09 10:11:47 UTC (rev 122)
+++ pkg/RSienaTest/DESCRIPTION	2010-10-13 19:55:33 UTC (rev 123)
@@ -1,8 +1,8 @@
 Package: RSienaTest
 Type: Package
 Title: Siena - Simulation Investigation for Empirical Network Analysis
-Version: 1.0.12.122
-Date: 2010-10-09
+Version: 1.0.12.123
+Date: 2010-10-13
 Author: Various
 Depends: R (>= 2.9.0), xtable
 Imports: Matrix

Modified: pkg/RSienaTest/changeLog
===================================================================
--- pkg/RSienaTest/changeLog	2010-10-09 10:11:47 UTC (rev 122)
+++ pkg/RSienaTest/changeLog	2010-10-13 19:55:33 UTC (rev 123)
@@ -1,3 +1,7 @@
+2010-10-13 R-forge revision 123 RSienaTest only
+
+	* doc/RSienaDeveloper.tex: added details about change logs etc
+
 2010-10-09 R-forge revision 122
 
 	* src/siena07models.cpp: corrected loop for return of MH

Modified: pkg/RSienaTest/doc/RSienaDeveloper.tex
===================================================================
--- pkg/RSienaTest/doc/RSienaDeveloper.tex	2010-10-09 10:11:47 UTC (rev 122)
+++ pkg/RSienaTest/doc/RSienaDeveloper.tex	2010-10-13 19:55:33 UTC (rev 123)
@@ -58,11 +58,25 @@
 The introduction to the RSiena manual describes the basics of how to run the
 program, either `standalone' or within R. The help files in R describe how to
 use the R commands. Here I give some notes for developers.
-\section{Coding standards}
+\section{Coding standards etc}
 I describe the main details of our current practice:
 \subsection{General}
 \begin{enumerate}
-\item Use lots of spaces: particularly around operators and after commas.
+\item Before you commit an update to R-forge please do the following:
+\begin{enumerate}
+\item Record details of the files you have changed in the Changelog for each of
+  RSiena and RSienaTest. The two changelogs are kept identical, otherwise it
+  gets very confusing.
+\item Update the version number and date in the \textsf{DESCRIPTION} file for
+  each package.
+\item Update the version number and date in \textsf{man/RSiena-package.Rd} in
+  each package.
+\item If the change would be noticeable to the users, add the details to the
+  change log at the end of the manual. Create a new pdf and copy to the inst/doc
+  directory of each package.
+\end{enumerate}
+\item Use lots of spaces: particularly around operators and after commas. (But
+  not after the end of your lines!)
 \item Do not use underscores: use variable names made up of several (possibly
   abbreviated, but ideally not) words with all but the first capitalised.
 \item Use braces even when not strictly necessary in \sfn{if} and \sfn{for}
@@ -151,7 +165,7 @@
 to clear out all the .o's and the dll.
 \item On Windows the install procedure downloads the gui installer. If you want
   to bypass this, rename the file \verb|configure.win| in the package
-  directory. 
+  directory.
 \item On linux or Mac, the same commands should work, but you don't need the
   Rtools. I have occasionally had problems with installing from a tarball or
   from source, when I have no permission to write in the standard libraries, but
@@ -191,7 +205,7 @@
 \end{enumerate}
 \paragraph{Making  binaries}
 If you want to send someone a Windows binary for some reason: on a Windows
-machine, use 
+machine, use
 
 \verb|R CMD INSTALL --build RSiena|
 
@@ -199,7 +213,7 @@
 GPL licensing.
 
 If you are lucky the same will work with Mac binaries on a Mac, but I have not
-tried this recently, and I may have forgotten some trick. 
+tried this recently, and I may have forgotten some trick.
 \section{Parallel runs}
 \begin{enumerate}
 \item In Siena3324xx source file \textsf{rangen.pas}, edit the lines at the

Modified: pkg/RSienaTest/man/RSiena-package.Rd
===================================================================
--- pkg/RSienaTest/man/RSiena-package.Rd	2010-10-09 10:11:47 UTC (rev 122)
+++ pkg/RSienaTest/man/RSiena-package.Rd	2010-10-13 19:55:33 UTC (rev 123)
@@ -30,8 +30,8 @@
 \tabular{ll}{
 Package: \tab RSiena\cr
 Type: \tab Package\cr
-Version: \tab 1.0.12.122\cr
-Date: \tab 2010-10-09\cr
+Version: \tab 1.0.12.123\cr
+Date: \tab 2010-10-13\cr
 License: \tab GPL-2 \cr
 LazyLoad: \tab yes\cr
 }