Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
*.iml
.DS_Store
.venv*
venv/
.pvenv
.nox
node_modules
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ For example:
},
}

These fields would then be availble to set in need directives, such as:
These fields would then be available to set in need directives, such as:

.. code-block:: rst

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contributing

This page provides a guide for developers wishing to contribute to **Sphinx-Needs**.

Bugs, Features and PRs
Bugs, Features and PRs
-----------------------

For **bug reports** and well-described **technical feature requests**, please use our issue tracker:
Expand Down
2 changes: 1 addition & 1 deletion docs/directives/need.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ but you must set a title as an argument (i.e. if you do not specify :ref:`needs_

Diagram support
---------------
A need objects can also define it's own PlantUML representation.
A need object can also define its own PlantUML representation.
Therefore Sphinx-Needs looks for the :ref:`needuml` directive inside the content
and stores its PlantUML code under given key from :ref:`needuml` directive under the option name ``arch``.

Expand Down
2 changes: 1 addition & 1 deletion docs/filter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ Filter string performance
.. versionadded:: 4.0.0

The filter string is evaluated by default for each need and need part
and, therefore, can be become a performance bottleneck for projects with large numbers of needs.
and, therefore, can become a performance bottleneck for projects with large numbers of needs.

To improve performance, certain common patterns are identified and optimized by the filter engine, and so using such patterns is recommended:

Expand Down
2 changes: 1 addition & 1 deletion docs/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Professional Support
--------------------
If you need professional support you should get in contact with our company `useblocks <http://useblocks.com>`_.

We are a bunch of passionated developers, who normally work on process, tool or embedded related projects for automotive
We are a bunch of passionate developers, who normally work on process, tool or embedded related projects for automotive
companies around the world.

Fastest way of reaching us is via e-mail: mail@useblocks.com.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Referring to a need item
------------------------

We can refer to the needs we create in the text using the :ref:`need role <role_need>`.
By default this will display the title and ID of the need item, but we can also different fields to display,
By default this will display the title and ID of the need item, but we can also display different fields,
by using an explicit title and using ``[[field]]`` syntax:


Expand Down Expand Up @@ -174,7 +174,7 @@ Lets also add some more need items to our plan:

The RADAR sensor software for the car must accurately detect and track surrounding objects
within a specified range. It should employ signal processing algorithms to filter out noise
nd interference, ensuring reliable object detection in various weather and road conditions.
and interference, ensuring reliable object detection in various weather and road conditions.
The software should integrate seamlessly with the car's control system, providing real-time
data on detected objects to enable collision avoidance and adaptive cruise control functionalities.
Additionally, it should adhere to industry standards for safety and reliability, with robust
Expand Down