-
Notifications
You must be signed in to change notification settings - Fork 0
/
pyment.1
52 lines (52 loc) · 1.29 KB
/
pyment.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.TH PYMENT "1" "Mai 2022" "PYMENT 0.3.4" "automatically turns docstrings into code signing"
.\" Text automatically generated by txt2man
.RS
.SH NAME
\fBpyment \fP- automatically turns docstrings into code signing
.SH SYNOPSIS
.nf
.fam C
\fBpyment\fP [\fIOPTION\fP]
\fBpyment\fP [\fIDIRECTORY\fP]
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBpyment\fP Generate, automatically convert code signing docstrings. Developed
for Python programmers who make use of docstrings in their projects.
It is useful for code not well documented, or code without docstrings,
or some code not yet or partially documented, or a mixture of all these.
It can also be useful to harmonize or change a project docstring style
format.
.SH OPTIONS
.TP
.B
\fBpyment\fP
myfile.py # will generate a patch.
.TP
.B
\fBpyment\fP
\fB-w\fP myfile.py # will overwrite the file.
.TP
.B
\fBpyment\fP
\fB-h\fP # get help.
.SH EXAMPLES
run from the command line:
.TP
.B
\fBpyment\fP
my/folder/
.TP
.B
\fBpyment\fP
myfile.py
.SH REPORTING BUGS
To report a bug please visit cargo strip issues tracking system at:
https://github.com/dadadel/\fBpyment\fP/issues
.SH AUTHORS
Written by A. Daouzli <[email protected]>
This manual page was written by Josenison F. da Silva
<[email protected]> for the Debian project
(but may be used by others).