Skip to content

Commit 7bbe84a

Browse files
author
haghish
committed
2.0.3
updating the documentation of the package and generating the package vignette
1 parent 3ea27c4 commit 7bbe84a

File tree

12 files changed

+39
-38
lines changed

12 files changed

+39
-38
lines changed

github.ado

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
/***
44
_v. 2.0.0_
55
6-
Title
7-
=====
6+
github
7+
======
88
9-
__github__ - search, install, and uninstall Stata packages with a particular
10-
version (release) as well as their dependencies from
9+
__github__ is a program for searching, installing, and managing Stata packages
10+
as well as their dependencies from
1111
[GitHub](http://www.github.com/haghish/github) website
1212
1313
Syntax
@@ -28,7 +28,6 @@ where the subcommands can be:
2828
| findfile | followed by a _keyword_, it searches Stata packages for files that include the keyword |
2929
| list | lists the packages installed from GitHub and checkes if they have an update |
3030
31-
3231
Description
3332
-----------
3433
@@ -70,7 +69,6 @@ searching for a keyword. The table shows the options accordingly:
7069
| in(_str_) | specifies the domain of the search which can be __name__, __description__, __readme__, or __all__ |
7170
| all | shows repositories that lack the __pkg__ and __stata.toc__ files in the search results |
7271
73-
7472
Installing package dependencies
7573
-------------------------------
7674

github.sthlp

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
{it:v. 2.0.0}
33

44

5-
{title:Title}
5+
{title:github}
66

77
{p 4 4 2}
8-
{bf:github} - search, install, and uninstall Stata packages with a particular
9-
version (release) as well as their dependencies from
8+
{bf:github} is a program for searching, installing, and managing Stata packages
9+
{space 1}as well as their dependencies from
1010
{browse "http://www.github.com/haghish/github":GitHub} website
1111

1212

@@ -29,7 +29,6 @@ where the subcommands can be:
2929
{col 5}list{col 19}lists the packages installed from GitHub and checkes if they have an update
3030
{space 4}{hline}
3131

32-
3332
{title:Description}
3433

3534
{p 4 4 2}
@@ -74,7 +73,6 @@ searching for a keyword. The table shows the options accordingly:
7473
{col 5}all{col 19}shows repositories that lack the {bf:pkg} and {bf:stata.toc} files in the search results
7574
{space 4}{hline}
7675

77-
7876
{title:Installing package dependencies}
7977

8078
{p 4 4 2}

githublistpack.ado

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/***
22
_v. 1.0.0_
33
4-
Title
5-
=====
4+
githublistpack
5+
==============
66
7-
__githublistpack__ - mines the GitHub API for Stata repositories
7+
mines the GitHub API for Stata repositories
88
99
Syntax
1010
------

githublistpack.sthlp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
{it:v. 1.0.0}
33

44

5-
{title:Title}
5+
{title:githublistpack}
66

77
{p 4 4 2}
8-
{bf:githublistpack} - mines the GitHub API for Stata repositories
8+
mines the GitHub API for Stata repositories
99

1010

1111
{title:Syntax}

make.ado

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ _v. 1.1_
77
make
88
====
99
10-
__make__ builds package installation files
10+
builds package installation files
1111
1212
Syntax
1313
------

make.do

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,19 +63,15 @@ markdoc "findall.ado", mini export(md) replace
6363
/*
6464
Generating the package vignette
6565
-----------------------------------------
66-
67-
change the WD to the cloned Wiki repository and then generate the vignettes
6866
*/
6967

70-
cd "/Users/haghish/Documents/GitHub/github.wiki"
71-
72-
markdoc "vignette.do", export(tex) toc replace master ///
68+
markdoc "vignette.do", mini export(html) replace ///
7369
title("github v. 2.0.0 package vignette") ///
7470
author("E. F. Haghish") ///
7571
affiliation("University of Goettingen") ///
7672
address("haghish@med.uni-goettingen.de")
7773

78-
markdoc "vignette.do", export(html) toc replace master ///
74+
markdoc "vignette.do", export(tex) toc replace master ///
7975
title("github v. 2.0.0 package vignette") ///
8076
author("E. F. Haghish") ///
8177
affiliation("University of Goettingen") ///
@@ -86,4 +82,5 @@ markdoc "vignette.do", export(html) toc replace master ///
8682

8783

8884

85+
8986
å

make.sthlp

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
{it:v. 1.1}
33

44

5-
{title:Title}
5+
{title:make}
66

77
{p 4 4 2}
8-
{bf:makee} - builds package installation files
8+
builds package installation files
99

1010

1111
{title:Syntax}
@@ -42,7 +42,7 @@ hosted on private websites or GitHub
4242

4343

4444

45-
{title:Example(s)}
45+
{title:Example}
4646

4747
{p 4 4 2}
4848
building the installation files for "mypackage" program
@@ -61,8 +61,16 @@ building the installation files for "mypackage" program
6161
{title:Author}
6262

6363
{p 4 4 2}
64-
{browse "https://github.com/haghish":E. F. Haghish} {break}
65-
University of Göttinge
64+
E. F. Haghish {break}
65+
University of Göttingen {break}
66+
{it:haghish@med.uni-goesttingen.de} {break}
67+
{browse "https://github.com/haghish":https://github.com/haghish}
68+
69+
70+
{title:License}
71+
72+
{p 4 4 2}
73+
MIT License
6674

6775
{space 4}{hline}
6876

pkgzip.ado

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/***
22
_v. 1.1_
33
4-
Title
5-
=====
4+
pkgzip
5+
======
66
7-
__pkgzip__ - creates and downloads a Zip file from SSC and names it based on the package release date
7+
creates and downloads a Zip file from SSC and names it based on the package release date
88
99
Syntax
1010
------

pkgzip.sthlp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
{it:v. 1.1}
33

44

5-
{title:Title}
5+
{title:pkgzip}
66

77
{p 4 4 2}
8-
{bf:pkgzip} - creates and downloads a Zip file from SSC and names it based on the package release date
8+
creates and downloads a Zip file from SSC and names it based on the package release date
99

1010

1111
{title:Syntax}

sscminer.ado

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/***
22
_v. 1.0.0_
33
4-
Title
5-
=====
4+
sscminer
5+
========
66
7-
__sscminer__ - mines and archives SSC packages based on their updates
7+
mines and archives SSC packages based on their updates
88
99
Syntax
1010
------

0 commit comments

Comments
 (0)