This repository has been archived by the owner on Nov 19, 2024. It is now read-only.
[TASK] Remove caption of code snippet #459
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
The caption is wrong, as the example should be added to a page field according to the description and not to a file. Releases: main, 12.4
|
Simply removing the caption is not a solution. It should then state where to put the code. This topic frequently confuses newbies. So removing the caption does not really improve the situation. Or we could insert a condition instead? |
|
It is said in the text above, that it should be added to the page: So, it is clearly stated. |
|
We made the rule a while back that each code snippet should have information on where to put it or the fact that is an example output right in the caption. This we decided after there was a lot of feedback that new users are confused about where to put the code from examples. So they should never be removed but only improved or corrected |
linawolf
reviewed
Apr 14, 2024
Co-authored-by: Lina Wolf <[email protected]>
linawolf
approved these changes
Apr 15, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The caption is wrong, as the example should be added to a page field according to the description and not to a file.
Releases: main, 12.4