Skip to content

Commit

Permalink
small improvements to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaehne committed Jul 14, 2023
1 parent ca4d57d commit cf0754b
Show file tree
Hide file tree
Showing 7 changed files with 1,496 additions and 18 deletions.
15 changes: 7 additions & 8 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Contributing
************

LumiSpy is meant to be a community maintained project. We welcome contributions
LumiSpy is a community-maintained project. We welcome contributions
in the form of bug reports, documentation, code, feature requests, and more.
In the following we refer to some resources to help you make useful contributions.
In the following, we summarize some resources to help you make useful contributions.

Issues
======
Expand All @@ -21,18 +21,17 @@ Pull Requests
=============

If you want to contribute to the LumiSpy source code, you can send us a
`pull request <https://github.com/lumispy/lumispy/pulls>`_. Small bug fixes are
`pull request <https://github.com/lumispy/lumispy/pulls>`_. Small bug fixes or
corrections to the user guide are typically a good starting point. But don't
hesitate also for significant code contributions - if needed, we'll help you
to get the code ready to common standards.

Please refer to the
`HyperSpy developer guide <http://hyperspy.org/hyperspy-doc/current/dev_guide/intro.html>`_
Being an extension to HyperSpy, please refer to the `HyperSpy
developer guide <http://hyperspy.org/hyperspy-doc/current/dev_guide/intro.html>`_
in order to get started and for detailed contributing guidelines.

The :doc:`kikuchipy contributors guide <kikuchipy:dev/index>`, another HyperSpy
extension, also is a valuable resource that can get you started and provides useful
guidelines.
extension, also is a valuable resource that provides useful guidelines.

Reviewing
---------
Expand Down Expand Up @@ -64,7 +63,7 @@ functionality. You can contribute through pull requests to the respective reposi
Code style
==========

LumiSpy follows `Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_
LumiSpy follows the `Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_
with `The Black Code style
<https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html>`_.

Expand Down
8 changes: 7 additions & 1 deletion doc/source/citing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ badge below is the `Concept DOI <https://help.zenodo.org/#versioning>`_ --
it can be used to cite the project without referring to a specific
version. If you are citing LumiSpy because you have used it to process data,
please use the DOI of the specific version that you have employed. You can
find it by clicking on the DOI badge below:
find it by clicking on the DOI badge:

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4640445.svg
:target: https://doi.org/10.5281/zenodo.4640445

DOIs for the LumiSpy project are provided by the `Zenodo <https://zenodo.org>`_
repository.

If the LumiSpy project has proven useful for your work, please consider awarding a
star to our `github repository <https://github.com/lumispy/lumispy/stargazers>`_.
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ workflows.
.. note::

This project is under active development. Everyone is welcome to contribute.
Please read our (see :ref:`contributing_label`) guidelines and get started!
Please read our:ref:`contributing_label` guidelines and get started!

Contents
========
Expand Down
2 changes: 1 addition & 1 deletion doc/source/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ LumiSpy is free software: you can redistribute it and/or modify
it under the terms of the `GNU General Public License (GPL)
<https://www.gnu.org/licenses/#GPL>`_ as published by
the Free Software Foundation, either version 3 of the license, or
(at your option) any later version.
any later version.

LumiSpy is distributed in the hope that it will be useful,
but **without any warranty**; without even the implied warranty of
Expand Down
Loading

0 comments on commit cf0754b

Please sign in to comment.