Skip to content

Commit b876b21

Browse files
lukelbdlukelbd
committed
Change stylized name 'ProPlot' to 'proplot'
1 parent 1808a2a commit b876b21

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+394
-378
lines changed

‎HOWTOCONTRIBUTE.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ How to contribute?
55
==================
66

77
Contributions of any size are highly appreciated! You can make
8-
a significant impact on ProPlot just by using it and
8+
a significant impact on proplot just by using it and
99
reporting `issues <https://github.com/lukelbd/proplot/issues>`__.
1010

1111
The following sections cover some general guidelines
12-
regarding development in ProPlot for contributors.
12+
regarding development in proplot for contributors.
1313
Feel free to suggest improvements or changes in the workflow.
1414

1515
Feature requests and feedback
@@ -41,13 +41,13 @@ Write tests
4141

4242
Most modern python packages have ``test_*.py`` scripts that are run by `pytest`
4343
via the `Travis Continuous Integration <https://travis-ci.com>`__ service
44-
whenever commits are pushed to the repository. Currently, ProPlot only tests
44+
whenever commits are pushed to the repository. Currently, proplot only tests
4545
the examples that appear on the website User Guide (see `.travis.yml`). While we
4646
try to make the examples comprehensive, this approach leaves out a lot of use
4747
cases and leaves the project more vulnerable to bugs. Adding tests is a
4848
*critical* item on our to-do list.
4949

50-
If you can think of a useful test for ProPlot, feel free to submit a pull request.
50+
If you can think of a useful test for proplot, feel free to submit a pull request.
5151
Your test will be used in the future.
5252

5353

@@ -71,7 +71,7 @@ documentation files directly in the GitHub web interface without using a local c
7171
is ``py:obj``. Please include ``py:obj`` links whenever discussing particular
7272
functions or classes -- for example, if you are discussing the
7373
`~proplot.axes.Axes.format` method, please write ```~proplot.axes.Axes.format```
74-
rather than ``format``. ProPlot also uses
74+
rather than ``format``. Proplot also uses
7575
`intersphinx <http://www.sphinx-doc.org/en/stable/ext/intersphinx.html>`__ so you can
7676
link to external packages like matplotlib and cartopy.
7777

@@ -113,7 +113,7 @@ Here is a quick guide for submitting pull requests:
113113
If you need some help with git, follow the
114114
`quick start guide <https://git.wiki.kernel.org/index.php/QuickStart>`__.
115115

116-
#. Make an editable install of ProPlot by running:
116+
#. Make an editable install of proplot by running:
117117

118118
.. code-block:: bash
119119
@@ -194,18 +194,18 @@ Here is a quick guide for submitting pull requests:
194194
base: master
195195
196196
Note that you can create the pull request before you're finished with your
197-
feature addition or bug fix. The PR will update as you add more commits. ProPlot
197+
feature addition or bug fix. The PR will update as you add more commits. Proplot
198198
developers and contributors can then review your code and offer suggestions.
199199

200200

201201
Release procedure
202202
=================
203203

204-
Once version 1.0 is released, ProPlot will follow semantic versioning, with version
204+
Once version 1.0 is released, proplot will follow semantic versioning, with version
205205
numbers that look like ``vX.Y.Z``. A major version (``X``) causes incompatible
206206
API changes, a minor version (``Y``) adds functionality, and a patch (``Z``) covers
207207
bug fixes. But these are not strict rules -- more like guidelines.
208-
Currently, ProPlot's major version number is ``0``, reflecting the fact that
208+
Currently, proplot's major version number is ``0``, reflecting the fact that
209209
the API is new and subject to rapid changes (although we try to make sure the
210210
changes are not without warning).
211211

‎INSTALL.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Installation
22
============
33

4-
ProPlot is published on `PyPi <https://pypi.org/project/proplot/>`__
4+
Proplot is published on `PyPi <https://pypi.org/project/proplot/>`__
55
and `conda-forge <https://conda-forge.org>`__. It can be installed
66
with ``pip`` or ``conda`` as follows:
77

@@ -10,20 +10,20 @@ with ``pip`` or ``conda`` as follows:
1010
pip install proplot
1111
conda install -c conda-forge proplot
1212
13-
Likewise, an existing installation of ProPlot can be upgraded to the latest version with:
13+
Likewise, an existing installation of proplot can be upgraded to the latest version with:
1414

1515
.. code-block:: bash
1616
1717
pip install --upgrade proplot
1818
conda upgrade proplot
1919
2020
21-
To install a development version of ProPlot, you can use
21+
To install a development version of proplot, you can use
2222
``pip install git+https://github.com/lukelbd/proplot.git``
2323
or clone the repository and run ``pip install -e .`` inside
2424
the ``proplot`` folder.
2525

26-
ProPlot's only hard dependency is `matplotlib <https://matplotlib.org/>`__.
26+
Proplot's only hard dependency is `matplotlib <https://matplotlib.org/>`__.
2727
The *soft* dependencies are `cartopy <https://scitools.org.uk/cartopy/docs/latest/>`__,
2828
`basemap <https://matplotlib.org/basemap/index.html>`__,
2929
`xarray <http://xarray.pydata.org>`__, and `pandas <https://pandas.pydata.org>`__.

‎README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The documentation is `published on readthedocs <https://proplot.readthedocs.io>`
1414
Installation
1515
============
1616

17-
ProPlot is published on `PyPi <https://pypi.org/project/proplot/>`__ and
17+
Proplot is published on `PyPi <https://pypi.org/project/proplot/>`__ and
1818
`conda-forge <https://conda-forge.org>`__. It can be installed with ``pip`` or
1919
``conda`` as follows:
2020

@@ -23,15 +23,15 @@ ProPlot is published on `PyPi <https://pypi.org/project/proplot/>`__ and
2323
pip install proplot
2424
conda install -c conda-forge proplot
2525
26-
Likewise, an existing installation of ProPlot can be upgraded
26+
Likewise, an existing installation of proplot can be upgraded
2727
to the latest version with:
2828

2929
.. code-block:: bash
3030
3131
pip install --upgrade proplot
3232
conda upgrade proplot
3333
34-
To install a development version of ProPlot, you can use
34+
To install a development version of proplot, you can use
3535
``pip install git+https://github.com/lukelbd/proplot.git``
3636
or clone the repository and run ``pip install -e .``
3737
inside the ``proplot`` folder.

0 commit comments

Comments
 (0)