| Message ID | 20240417101201.715518-1-pvorel@suse.cz |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [1/1] doc: documentation: Fix typo other => older | expand |
Hi! > I suppose you mean "older", otherwise the sentence does not make sense > to me (i.e. which versions caused problems?) Can we fix this one in the same patch as well? diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst index 30dacd384..b56d5b4c7 100644 --- a/doc/developers/documentation.rst +++ b/doc/developers/documentation.rst @@ -11,7 +11,7 @@ and it's built on top of `Sphinx <https://www.sphinx-doc.org/en/master/>`_. Building documentation ~~~~~~~~~~~~~~~~~~~~~~ -First of all, to build the documentation we must be sure that all dependences +First of all, to build the documentation we must be sure that all dependencies have been installed (please check ``doc/requirements.txt`` file). Sometimes the Linux distros are providing them, but the best way is to use ``virtualenv``
> Hi! > > I suppose you mean "older", otherwise the sentence does not make sense > > to me (i.e. which versions caused problems?) > Can we fix this one in the same patch as well? > diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst > index 30dacd384..b56d5b4c7 100644 > --- a/doc/developers/documentation.rst > +++ b/doc/developers/documentation.rst > @@ -11,7 +11,7 @@ and it's built on top of `Sphinx <https://www.sphinx-doc.org/en/master/>`_. > Building documentation > ~~~~~~~~~~~~~~~~~~~~~~ > -First of all, to build the documentation we must be sure that all dependences > +First of all, to build the documentation we must be sure that all dependencies Sure, just waiting on Andrea's ack. BTW how does these spellchecker feature in sphinx works? Did you find it to run something (tox -e spelling -r [1] or did you spot it manually? I hoped that errors like this would be caught, e.g. we might want to have CI check for it, right? Kind regards, Petr [1] https://sphinxcontrib-spelling.readthedocs.io/en/latest/run.html > have been installed (please check ``doc/requirements.txt`` file). Sometimes the > Linux distros are providing them, but the best way is to use ``virtualenv``
Hi! On 4/17/24 14:19, Petr Vorel wrote: >> Hi! >>> I suppose you mean "older", otherwise the sentence does not make sense >>> to me (i.e. which versions caused problems?) >> Can we fix this one in the same patch as well? >> diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst >> index 30dacd384..b56d5b4c7 100644 >> --- a/doc/developers/documentation.rst >> +++ b/doc/developers/documentation.rst >> @@ -11,7 +11,7 @@ and it's built on top of `Sphinx <https://www.sphinx-doc.org/en/master/>`_. >> Building documentation >> ~~~~~~~~~~~~~~~~~~~~~~ >> -First of all, to build the documentation we must be sure that all dependences >> +First of all, to build the documentation we must be sure that all dependencies > Sure, just waiting on Andrea's ack. Acked-by: Andrea Cervesato <andrea.cervesato@suse.com> > > BTW how does these spellchecker feature in sphinx works? Did you find it to run something > (tox -e spelling -r [1] or did you spot it manually? aspell didn't catch it apparently.. > > I hoped that errors like this would be caught, e.g. we might want to have CI > check for it, right? > > Kind regards, > Petr > > [1] https://sphinxcontrib-spelling.readthedocs.io/en/latest/run.html > >> have been installed (please check ``doc/requirements.txt`` file). Sometimes the >> Linux distros are providing them, but the best way is to use ``virtualenv`` Andrea
Hi! > BTW how does these spellchecker feature in sphinx works? Did you find it to run something > (tox -e spelling -r [1] or did you spot it manually? You have to run make spelling as described in the documentation. > I hoped that errors like this would be caught, e.g. we might want to have CI > check for it, right? The problem is that there are false possitives, so we can't simply plug it into a CI as it is now.
> Hi! > > BTW how does these spellchecker feature in sphinx works? Did you find it to run something > > (tox -e spelling -r [1] or did you spot it manually? > You have to run make spelling as described in the documentation. > > I hoped that errors like this would be caught, e.g. we might want to have CI > > check for it, right? > The problem is that there are false possitives, so we can't simply plug > it into a CI as it is now. Sure, agree. It'd be good just time to time to run it. github actions also have a warning message [1] (to check it time to time and fix or whitelist), but looking at the spelling output it's quite noisy (tests also venv, the only real thing I see is "Spell check: nr" => whitelist "nr"). Kind regards, Petr [1] https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-warning-message
diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst index cfc8bf6f5..ba7b61a43 100644 --- a/doc/developers/documentation.rst +++ b/doc/developers/documentation.rst @@ -36,7 +36,7 @@ Once the procedure has been completed, documentation will be visible at .. warning:: The current ``.readthedocs.yml`` workflow is using ``Python 3.6`` because - other Python versions were causing issues. No other version has been tested, + older Python versions were causing issues. No other version has been tested, but it should work anyway. Validating spelling
Fixes: 638934e8b ("doc: Documentation usage and development") Signed-off-by: Petr Vorel <pvorel@suse.cz> --- Hi Andrea, I suppose you mean "older", otherwise the sentence does not make sense to me (i.e. which versions caused problems?) Kind regards, Petr doc/developers/documentation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)