Skip to content

Commit

Permalink
fix naming in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bdpedigo committed Dec 2, 2020
1 parent ac8e833 commit 9aeb03e
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 23 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.rst
Expand Up @@ -13,7 +13,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/bdpedigo/sparse_matrix_analysis/issues.
Report bugs at https://github.com/bdpedigo/sparse_decomposition/issues.

If you are reporting a bug, please include:

Expand All @@ -36,14 +36,14 @@ is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~

Sparse Matrix Analysis could always use more documentation, whether as part of the
official Sparse Matrix Analysis docs, in docstrings, or even on the web in blog posts,
sparse_decomposition could always use more documentation, whether as part of the
official sparse_decomposition docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/bdpedigo/sparse_matrix_analysis/issues.
The best way to send feedback is to file an issue at https://github.com/bdpedigo/sparse_decomposition/issues.

If you are proposing a feature:

Expand All @@ -55,13 +55,13 @@ If you are proposing a feature:
Get Started!
------------

Ready to contribute? Here's how to set up `sparse_matrix_analysis` for
Ready to contribute? Here's how to set up `sparse_decomposition` for
local development.

1. Fork_ the `sparse_matrix_analysis` repo on GitHub.
1. Fork_ the `sparse_decomposition` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/sparse_matrix_analysis.git
$ git clone git@github.com:your_name_here/sparse_decomposition.git

3. Create a branch for local development::

Expand All @@ -84,7 +84,7 @@ To get tox, just pip install it.

6. Submit a pull request through the GitHub website.

.. _Fork: https://github.com/bdpedigo/sparse_matrix_analysis/fork
.. _Fork: https://github.com/bdpedigo/sparse_decomposition/fork

Pull Request Guidelines
-----------------------
Expand All @@ -96,7 +96,7 @@ Before you submit a pull request, check that it meets these guidelines:
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy.
Check https://travis-ci.org/bdpedigo/sparse_matrix_analysis
Check https://travis-ci.org/bdpedigo/sparse_decomposition
under pull requests for active pull requests or run the ``tox`` command and
make sure that the tests pass for all supported Python versions.

Expand All @@ -106,4 +106,4 @@ Tips

To run a subset of tests::

$ py.test test/test_sparse_matrix_analysis.py
$ py.test test/test_sparse_decomposition.py
16 changes: 8 additions & 8 deletions docs/conf.py
Expand Up @@ -173,7 +173,7 @@
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = "sparse_matrix_analysisdoc"
htmlhelp_basename = "sparse_decomposition_doc"


# -- Options for LaTeX output --------------------------------------------------
Expand All @@ -193,7 +193,7 @@
(
"index",
"sparse_matrix_analysis.tex",
u"Sparse Matrix Analysis Documentation",
u"Sparse Decomposition Documentation",
u"Benjamin Pedigo",
"manual",
),
Expand Down Expand Up @@ -227,8 +227,8 @@
man_pages = [
(
"index",
"sparse_matrix_analysis",
u"Sparse Matrix Analysis Documentation",
"sparse_decomposition",
u"Sparse Decomposition Documentation",
[u"Benjamin Pedigo"],
1,
)
Expand All @@ -246,11 +246,11 @@
texinfo_documents = [
(
"index",
"sparse_matrix_analysis",
u"Sparse Matrix Analysis Documentation",
"sparse_decomposition",
u"Sparse Decomposition Documentation",
u"Benjamin Pedigo",
"sparse_matrix_analysis",
"One line description of project.",
"sparse_decompositioni",
"Algorithms for sparse PCA and sparse matrix approximation from 'A New Basis for Sparse PCA'.",
"Miscellaneous",
),
]
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Expand Up @@ -20,8 +20,8 @@ Contents:
Feedback
========

If you have any suggestions or questions about **Sparse Matrix Analysis** feel free to email me
If you have any suggestions or questions about **Sparse Decomposition** feel free to email me
at benjamindpedigo@gmail.com.

If you encounter any errors or problems with **Sparse Matrix Analysis**, please let me know!
Open an Issue at the GitHub http://github.com/bdpedigo/sparse_matrix_analysis main repository.
If you encounter any errors or problems with **Sparse Decomposition**, please let me know!
Open an Issue at the GitHub http://github.com/bdpedigo/sparse_decomposition main repository.
4 changes: 2 additions & 2 deletions docs/usage.rst
Expand Up @@ -2,6 +2,6 @@
Usage
========

To use Sparse Matrix Analysis in a project::
To use Sparse Decomposition in a project::

import sparse_matrix_analysis
import sparse_decomposition

0 comments on commit 9aeb03e

Please sign in to comment.