Skip to content

Commit

Permalink
presents even more progress
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielfalcao committed Jan 2, 2024
1 parent 16effc5 commit 959afd0
Show file tree
Hide file tree
Showing 15 changed files with 766 additions and 652 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ docs: html-docs

test tests: clean | $(VENV)/bin/pytest # $(VENV)/bin/nosetests # @$(VENV)/bin/nosetests --rednose --immediate -vv --with-coverage --cover-package=sure
@$(VENV)/bin/pytest --cov=sure --ignore tests/crashes tests
$(MAIN_CLI_PATH) --special-syntax --with-coverage --cover-branches --cover-module=sure --immediate tests/

# run main command-line tool
run: | $(MAIN_CLI_PATH)
$(MAIN_CLI_PATH) --reporter=test tests/crashes || true
$(MAIN_CLI_PATH) --special-syntax --with-coverage --cover-branches --cover-module=sure.core --cover-module=sure tests/runner
$(MAIN_CLI_PATH) --special-syntax --with-coverage --cover-branches --cover-module=sure --immediate --cover-module=sure tests

# Pushes release of this package to pypi
push-release: dist # pushes distribution tarballs of the current version
Expand Down
4 changes: 2 additions & 2 deletions docs/source/api-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ API Reference
.. autofunction:: sure.word_to_number
.. autofunction:: sure.assertionmethod
.. autofunction:: sure.assertionproperty
.. autoclass:: sure.IdentityAssertion
.. autoclass:: sure.ObjectIdentityAssertion
.. autoclass:: sure.AssertionBuilder
.. autofunction:: sure.assertion
.. autofunction:: sure.chain
Expand All @@ -27,7 +27,7 @@ API Reference
-------------

.. automodule:: sure.core
.. autoclass:: sure.core.DeepExplanation
.. autoclass:: sure.core.Explanation
.. _deep comparison:
.. autoclass:: sure.core.DeepComparison
.. autofunction:: sure.core.itemize_length
Expand Down
54 changes: 54 additions & 0 deletions docs/source/definitions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
.. _Definitions:

Definitions
===========


This section defines terms used across :ref:`Sure`'s documentation,
code and run-time error messages and must be interpreted accordingly
as to prevent confusion, misunderstanding and abuse of any manner,
form or kind be it real or virtual.

Each term is defined in the subsections below which are titled by the
term itself and followed by the actual definition of the term in case
which shall be entirely comprehended as they appear typographically
written regardless of capitalization. Synonyms may be presented within
each of those sections.

These terms might be updated in the event of emerging incorrectness or
general evolution of the :ref:`Sure` project.


truthy
------

Defines Python objects whose logical value is equivalent to the
boolean value of ``True``.

More specifically, any valid Python code evaluted by :class:`bool` as
``True`` might appear written as ``truthy`` within the scope of
:ref:`Sure`.

Synonyms: ``true``, ``truthy``, ``ok``


falsy
-----

Defines Python objects whose logical value is equivalent to the
boolean value of ``False``.

More specifically, any valid Python code evaluted by :class:`bool` as
``False`` might appear written as ``falsy`` within the scope of
:ref:`Sure`.

Synonyms: ``false``, ``falsy``, ``not_ok``


none
----

Defines Python objects whose logical value is equivalent to the
boolean value of ``False``.

Synonyms: ``none``, ``None``
3 changes: 2 additions & 1 deletion docs/source/how-it-works.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ statements below:
from sure import assert_that
from sure import it
from sure import expect
from sure import expects
from sure import that
from sure import the
from sure import these
Expand Down Expand Up @@ -161,7 +162,7 @@ details and instead bring as much detail as possible in the occasion
of such exception, to the point of doing its best to show at what key
or what index there is a difference in the case of testing equality
between the datastructures :class:`dict` or :class:`list`,
respectivelly in this case. (See :class:`sure.DeepExplanation` for more)
respectivelly in this case. (See :class:`sure.Explanation` for more)

Gabriel's initial idea came from believing that other programming
languages suchs as Ruby or Javascript had tools or libraries such as
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Contents:

intro
getting-started
definitions
assertion-reference
how-it-works
api-reference
Expand Down

0 comments on commit 959afd0

Please sign in to comment.