Skip to content

Commit

Permalink
All vcs docstrings updated merged (#2117)
Browse files Browse the repository at this point in the history 
* Fixes #2061

* Changes to fix CI errors

* Updated docstrings

* Added parameter descriptions and types to Canvas, manageElements.

* Formatted meshfill.Gfm class docstring

* Reformatted marcker.Tm class docstring. Added marker_script to xmldocs.

* Changed Canvas.plot() docstring to more cleanly formatted RST.

* Formatted line.Tl class docstring.

* Re-formatted fillarea.Tm to the newer, cleaner style.

* Extracted lots of queries dacstrings to xmldocs.

Finished documenting queries.

* Fixed typo in queries

* queries finished for reals this time, guys.

* reformatted unified.G1d class docstring:

* vcs.template done.

Moved internal documentation to line comments. Reformatted P class docstring. Documented necessary user-facing functions.

* Working on formatting Proj class tables

* Finished Proj class table markup. Proj class docstring WIP.

* Removed user-facing docstrings for process_src()

Added more scriptdocs to xmldocs.

* Finished all script() documentation.

Restructured xmldocs scripts to be smarter & easier to read.

* Doing xmldocs in an even more not stupid way.

* Reformatted Pds class docstring

* Reformatted template docstrings for P__ classes.

Reformatted Tc class docstring.

* Reformatted To class docstring

* Reformatted Tt class docstring

* Reformatted Gv class docstring

* Got most of utils documentation done. Still some ???s.

* Restructuring Example formats.

* Updating Examples for doctest running

* Added taylor.py documentation. Formatted more doctest strings.

* Refining taylor.py docstrings. Fixing up doctest strings.

* Reformatted vcs.isoline.Gi class docstring.

* Adding links to VCS Authors. Cleaning other refs up.

* Reformated vcs.displayplot.Dp class docstring.

* Reformatted vcs.boxfill.Gfb class docstring.

* Incorporating xmldocs into class docstrings.

* Reformatting xmldocs docstrings.

* Reformatted isofill docstring. Cleaned up xmldocs a little.

* Reformatted some docstrings

* Took care of clear 'Overfull hbox' errors when building pdf

* Trying to fix some pdf errors and a bad reference error.

* Setting up to replace all 'get____' docstrings with an xmldocs variable

* flake8'd

* Fixed missing line
  • Loading branch information
@doutriaux1
doutriaux1 committed Sep 7, 2016
1 parent c812cee commit 8c56df9
Show file tree
Hide file tree
Showing 33 changed files with 4,951 additions and 3,939 deletions.
858 changes: 470 additions & 388 deletions Packages/vcs/vcs/Canvas.py
View file

Large diffs are not rendered by default.

72 changes: 43 additions & 29 deletions Packages/vcs/vcs/Pboxeslines.py
View file
Expand Up @@ -34,42 +34,56 @@
class Pbl(object):

'''
Class: Pbl # Template text
Description of Pbl Class:
The Template text object allows the manipulation of line type, width, and color index.
This class is used to define an line table entry used in VCS, or it
This class is used to define a line table entry used in VCS, or it
can be used to change some or all of the line attributes in an
existing line table entry.
Other Useful Functions:
a=vcs.init() # Constructor
a.show('line') # Show predefined line objects
a.update() # Updates the VCS Canvas at user's request
a.mode=1, or 0 # If 1, then automatic update, else if
0, then use update function to
update the VCS Canvas.
:Example:
::
# Basic Usage Overview:
Example of Use:
a=vcs.init()
To Create a new instance of line use:
ln=a.createline('new','red') # Copies content of 'red' to 'new'
ln=a.createline('new') # Copies content of 'default' to 'new'
To Modify an existing line use:
ln=a.getline('red')
ln.list() # Will list all the line attribute values
ln.color=100 # Range from 1 to 256
ln.width=100 # Range from 1 to 300
Specify the line type:
ln.type='solid' # Same as ln.type=0
ln.type='dash' # Same as ln.type=1
ln.type='dot' # Same as ln.type=2
ln.type='dash-dot' # Same as ln.type=3
ln.type='long-dash' # Same as ln.type=4
# Show predefined line objects
a.show('line')
# Updates the VCS Canvas at user's request
a.update()
#For mode:
# If 1, then automatic update.
# If 0,use update function to update VCS canvas
a.mode=1
#To Create a new instance of line use:
# Copies content of 'red' to 'new'
ln=a.createline('new','red')
# Copies content of 'default' to 'new'
ln=a.createline('new')
#To Modify an existing line use:
ln=a.getline('red')
# Will list all the line attribute values
ln.list()
# Range from 1 to 256
ln.color=100
# Range from 1 to 300
ln.width=100
#Specify the line type:
# Same as ln.type=0
ln.type='solid'
# Same as ln.type=1
ln.type='dash'
# Same as ln.type=2
ln.type='dot'
# Same as ln.type=3
ln.type='dash-dot'
# Same as ln.type=4
ln.type='long-dash'
'''
##########################################################################
# #
Expand Down
90 changes: 60 additions & 30 deletions Packages/vcs/vcs/Pdata.py
View file
Expand Up @@ -28,42 +28,72 @@
class Pds(object):

"""
Class: Pds # Template text
Description of Pds Class:
The Template text object allows the manipulation of line type, width, and color index.
This class is used to define an line table entry used in VCS, or it
can be used to change some or all of the line attributes in an
existing line table entry.
Other Useful Functions:
a=vcs.init() # Constructor
a.show('line') # Show predefined line objects
a.update() # Updates the VCS Canvas at user's request
a.mode=1, or 0 # If 1, then automatic update, else if
0, then use update function to
update the VCS Canvas.
Example of Use:
a=vcs.init()
To Create a new instance of line use:
ln=a.createline('new','red') # Copies content of 'red' to 'new'
ln=a.createline('new') # Copies content of 'default' to 'new'
To Modify an existing line use:
ln=a.getline('red')
ln.list() # Will list all the line attribute values
ln.color=100 # Range from 1 to 256
ln.width=100 # Range from 1 to 300
Specify the line type:
ln.type='solid' # Same as ln.type=0
ln.type='dash' # Same as ln.type=1
ln.type='dot' # Same as ln.type=2
ln.type='dash-dot' # Same as ln.type=3
ln.type='long-dash' # Same as ln.type=4
.. describe:: Useful Functions:
.. code-block:: python
# VCS Canvas Constructor
a=vcs.init()
# Show predefined line objects
a.show('line')
# Updates the VCS Canvas at user's request
a.update()
.. describe:: Make a Canvas object to work with:
.. code-block:: python
a=vcs.init()
.. describe:: Create a new instance of line:
.. code-block:: python
# Copies content of 'red' to 'new'
ln=a.createline('new','red')
# Copies content of 'default' to 'new'
ln=a.createline('new')
.. describe:: Modify an existing line:
.. code-block:: python
# Get a copy of 'red' line
ln=a.getline('red')
.. describe:: Overview of line attributes:
* Listing line attributes:
.. code-block:: python
# Will list all the line attribute values
ln.list()
# Range from 1 to 256
ln.color=100
# Range from 1 to 300
ln.width=100
* Specifying the line type:
.. code-block:: python
# Same as ln.type=0
ln.type='solid'
# Same as ln.type=1
ln.type='dash'
# Same as ln.type=2
ln.type='dot'
# Same as ln.type=3
ln.type='dash-dot'
# Same as ln.type=4
ln.type='long-dash'
"""
##########################################################################
# #
Expand Down
89 changes: 59 additions & 30 deletions Packages/vcs/vcs/Pformat.py
View file
Expand Up @@ -33,42 +33,71 @@
class Pf(object):

"""
Class: Pf # Template text
Description of Pf Class:
The Template text object allows the manipulation of line type, width, and color index.
This class is used to define an line table entry used in VCS, or it
can be used to change some or all of the line attributes in an
existing line table entry.
Other Useful Functions:
a=vcs.init() # Constructor
a.show('line') # Show predefined line objects
a.update() # Updates the VCS Canvas at user's request
a.mode=1, or 0 # If 1, then automatic update, else if
0, then use update function to
update the VCS Canvas.
Example of Use:
a=vcs.init()
To Create a new instance of line use:
ln=a.createline('new','red') # Copies content of 'red' to 'new'
ln=a.createline('new') # Copies content of 'default' to 'new'
To Modify an existing line use:
ln=a.getline('red')
ln.list() # Will list all the line attribute values
ln.color=100 # Range from 1 to 256
ln.width=100 # Range from 1 to 300
Specify the line type:
ln.type='solid' # Same as ln.type=0
ln.type='dash' # Same as ln.type=1
ln.type='dot' # Same as ln.type=2
ln.type='dash-dot' # Same as ln.type=3
ln.type='long-dash' # Same as ln.type=4
.. describe:: Useful Functions:
.. code-block:: python
# VCS Canvas Constructor
a=vcs.init()
# Show predefined line objects
a.show('line')
# Updates the VCS Canvas at user's request
a.update()
.. describe:: Make a Canvas object to work with:
.. code-block:: python
a=vcs.init()
.. describe:: Create a new instance of line:
.. code-block:: python
# Copies content of 'red' to 'new'
ln=a.createline('new','red')
# Copies content of 'default' to 'new'
ln=a.createline('new')
.. describe:: Modify an existing line:
.. code-block:: python
ln=a.getline('red')
.. describe:: Overview of line attributes:
* Listing line attributes:
.. code-block:: python
# Will list all the line attribute values
ln.list()
# Range from 1 to 256
ln.color=100
# Range from 1 to 300
ln.width=100
* Specifying the line type:
.. code-block:: python
# Same as ln.type=0
ln.type='solid'
# Same as ln.type=1
ln.type='dash'
# Same as ln.type=2
ln.type='dot'
# Same as ln.type=3
ln.type='dash-dot'
# Same as ln.type=4
ln.type='long-dash'
"""
__slots__ = [
"format",
Expand Down
93 changes: 61 additions & 32 deletions Packages/vcs/vcs/Plegend.py
View file
Expand Up @@ -33,44 +33,73 @@

class Pls(object):

'''
Class: Pls # Template text
Description of Pls Class:
"""
The Template text object allows the manipulation of line type, width, and color index.
This class is used to define an line table entry used in VCS, or it
can be used to change some or all of the line attributes in an
existing line table entry.
Other Useful Functions:
a=vcs.init() # Constructor
a.show('line') # Show predefined line objects
a.update() # Updates the VCS Canvas at user's request
a.mode=1, or 0 # If 1, then automatic update, else if
0, then use update function to
update the VCS Canvas.
Example of Use:
a=vcs.init()
To Create a new instance of line use:
ln=a.createline('new','red') # Copies content of 'red' to 'new'
ln=a.createline('new') # Copies content of 'default' to 'new'
To Modify an existing line use:
ln=a.getline('red')
ln.list() # Will list all the line attribute values
ln.color=100 # Range from 1 to 256
ln.width=100 # Range from 1 to 300
Specify the line type:
ln.type='solid' # Same as ln.type=0
ln.type='dash' # Same as ln.type=1
ln.type='dot' # Same as ln.type=2
ln.type='dash-dot' # Same as ln.type=3
ln.type='long-dash' # Same as ln.type=4
'''
.. describe:: Useful Functions:
.. code-block:: python
# VCS Canvas Constructor
a=vcs.init()
# Show predefined line objects
a.show('line')
# Updates the VCS Canvas at user's request
a.update()
.. describe:: Make a Canvas object to work with:
.. code-block:: python
a=vcs.init()
.. describe:: Create a new instance of line:
.. code-block:: python
# Copies content of 'red' to 'new'
ln=a.createline('new','red')
# Copies content of 'default' to 'new'
ln=a.createline('new')
.. describe:: Modify an existing line:
.. code-block:: python
ln=a.getline('red')
.. describe:: Overview of line attributes:
* Listing line attributes:
.. code-block:: python
# Will list all the line attribute values
ln.list()
# Range from 1 to 256
ln.color=100
# Range from 1 to 300
ln.width=100
* Specifying the line type:
.. code-block:: python
# Same as ln.type=0
ln.type='solid'
# Same as ln.type=1
ln.type='dash'
# Same as ln.type=2
ln.type='dot'
# Same as ln.type=3
ln.type='dash-dot'
# Same as ln.type=4
ln.type='long-dash'
"""
##########################################################################
# #
# Initialize the line attributes. #
Expand Down

0 comments on commit 8c56df9

Please sign in to comment.