Skip to contentSkip to conversation

doc: develop: testing: Fix more reference links

PATCH In review Alexander Dahl 2 participants 5 messages Jun 21, 2024

lore
Share & tools
lore
#0 lore raw

cover doc: develop: testing: Fix more reference links

Found some more broken reference links when reading the documentation.

Greets
Alex

Alexander Dahl (2):
doc: develop: testing: Fix broken reference to pytest suite help
doc: develop: testing: Fix reference to test writing section

 doc/develop/testing.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

base-commit: fe2ce09a0753634543c32cafe85eb87a625f76ca

Signature · 1 line
2.39.2
#1 lore raw

PATCH 1/2 doc: develop: testing: Fix broken reference to pytest suite help

This should have been adapted directly with or after v2021.01-693-gca6583d4e08 ("doc: move test/README to HTML documentation") or v2021.01-694-g0157619d5c8 ("doc: move test/py/README.md to HTML documentation") already.

---
 doc/develop/testing.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/develop/testing.rst +1 -1
index 5afeb42f696..056bdfd2b69 100644
@@ -69,7 +69,7 @@ build::
 
    ./test/py/test.py --bd sandbox_spl --build -k test_spl
 
-See test/py/README.md for more information about the pytest suite.
+See :doc:`py_testing` for more information about the pytest suite.
 
 See :doc:`tests_sandbox` for how to run tests directly (not through pytest).
 
Signature · 1 line
2.39.2
Reviewed-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] doc: develop: testing: Fix broken reference to pytest suite help

Quoted 11 lines · Alexander Dahl

This should have been adapted directly with or after v2021.01-693-gca6583d4e08 ("doc: move test/README to HTML documentation") or v2021.01-694-g0157619d5c8 ("doc: move test/py/README.md to HTML documentation") already.

---
 doc/develop/testing.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
#3 lore raw

PATCH 2/2 doc: develop: testing: Fix reference to test writing section

In reply to Alexander Dahl
Fixes fc3283314539 ("doc: Explain briefly how to write new tests")
---
 doc/develop/testing.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/develop/testing.rst +1 -1
index 056bdfd2b69..9114d11ad26 100644
@@ -123,7 +123,7 @@ or is covered sparingly. So here are some suggestions:
   is much easier to add onto a test - writing a new large test can seem
   daunting to most contributors.
 
-See doc:`tests_writing` for how to write tests.
+See :doc:`tests_writing` for how to write tests.
 
 
 Future work
Signature · 1 line
2.39.2
Reviewed-by on v1 2/2
#4 lore raw

Re: [PATCH 2/2] doc: develop: testing: Fix reference to test writing section

Quoted 6 lines · Alexander Dahl
Fixes fc3283314539 ("doc: Explain briefly how to write new tests")
---
 doc/develop/testing.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Please do always add a commit message

Quoted 17 lines
doc/develop/testing.rst +1 -2
index 056bdfd2b69..9114d11ad26 100644
@@ -123,7 +123,7 @@ or is covered sparingly. So here are some suggestions:
   is much easier to add onto a test - writing a new large test can seem
   daunting to most contributors.
 
-See doc:`tests_writing` for how to write tests.
+See :doc:`tests_writing` for how to write tests.
 
 
 Future work
--

2.39.2