Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up documentation #1525

Merged
merged 2 commits into from
Dec 22, 2021
Merged

Clean up documentation #1525

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8661dee
Remove trailing whitespace
ajnelson-nist Dec 21, 2021
5b3faa3
Fix documentation typos
ajnelson-nist Dec 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/developers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ If you add a new cool feature, consider also adding an example in ``./examples``
Tests
-----
Any new functionality being added to RDFLib _must_ have unit tests and
should have doc tests supplied.
should have doc tests supplied.

Typically, you should add your functionality and new tests to a branch of
RDFlib and and run all tests locally and see them pass. There are currently
Typically, you should add your functionality and new tests to a branch of
RDFlib and and run all tests locally and see them pass. There are currently
close to 4,000 tests with a few extra expected failures and skipped tests.
We won't allow Pull Requests that break any of the existing tests.

Expand All @@ -33,7 +33,7 @@ you say it is doing: if you remove your enhancement, your new tests should fail!

Finally, please consider adding simple and more complex tests. It's good to see
the basic functionality of your feature tests and then also any tricky bits or
edg cases.
edge cases.

Testing framework
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -66,7 +66,7 @@ failure tests than `unittest`.
A primer on how to write tests for pytest can be found `here
<https://docs.pytest.org/en/latest/getting-started.html#create-your-first-test>`_.

The existing test that use `unittest` work well with pytest, but they should
The existing tests that use `unittest` work well with pytest, but they should
ideally be updated to the pytest test-style when they are touched.

Test should go into the ``test/`` directory, either into an existing test file
Expand All @@ -78,7 +78,7 @@ should be named `test_*.py` so that `pytest can discover them
Running static checks
---------------------

Check formatting with `black <https://github.com/psf/black>`_, making sure you use
Check formatting with `black <https://github.com/psf/black>`_, making sure you use
our black.toml config file:

.. code-block:: bash
Expand Down