Improve "How to write tests" documentation #5406
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Make "Job dependencies" its own sub-section under "Advanced test features" as it is about dependencies in general so placing it under "Writing multi-machine tests" makes not much sense * Reduce the level of nesting in all affected sub-sections along the way * Keep the content as-is
* The Kate text editor has been used to make the process as automatic as possible. This means also lines that were too short have been re-wrapped. * The wrapping within code blocks has been preserved. * The wrapping has been preserved where changes would have potentially caused problems with the AsciiDoc.
* Improve grammar, especially casing and punctuation * Avoid excessive use of italics
|
Great PR! Please pay attention to the following items before merging: Files matching
This is an automatically generated QA checklist based on modified files. |
okurz
approved these changes
Dec 20, 2023
kraih
approved these changes
Dec 21, 2023
os-autoinst-bot
pushed a commit
to os-autoinst-bot/openQA
that referenced
this pull request
Dec 22, 2023
commit 1f7eb61 Merge: 3d06b02 23ec4a9 Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> AuthorDate: Thu Dec 21 16:42:02 2023 +0000 Commit: GitHub <[email protected]> CommitDate: Thu Dec 21 16:42:02 2023 +0000 Merge pull request os-autoinst#5406 from Martchus/doc Improve "How to write tests" documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is mainly about reformatting and restructuring. Checkout the particular commits for easier review. The real changes in wording/grammar are actually not much.
Note that everything after
==== SCHEDULE + ASSET_<NR>_URLis wrongly formatted as bold in the diff. However, I don't think this is related and the rendered version https://github.com/Martchus/openQA/blob/23ec4a97b27fd77dc3ad23a1b1b5fec07ff4290b/docs/WritingTests.asciidoc looks good. Of course I also tested the rendering of the whole documentation locally.