Updated Documentation Fix for Issue #1801 #1802
Merged
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.
Related Issues or bug [Documentation]:
There are 3 inconsistencies that are improved with this solution:
1.) There is no opening
<h1>
tag, so the closing</h1>
tag on line 36 should simply be removed to improve code correctness.2.) On line 36 of the file, the header, "Image Segmentation Using Color space and Opencv", should be "Image Segmentation Using Color space and OpenCV", which is consistent with the spelling on line 27: "Pencil Sketch In Python Using OpenCV." This the standard abbreviated acronym of the Open Computer Vision Library's official spelling.
3.) On line 193, the second-level header "## Piplines", is spelled incorrectly, and can be updated to "## Pipelines" to improve clarity for contributors.
Fixes: #1801 3 Updates to Improve Readability in Face-X/Awesome-face-operations/Readme.md
This pull request directly fixes the documentation inconsistencies raised in Issue #1801
Proposed Changes:
1.) The unclosed
</h1>
tag on line 36 has been removed to improve code correctness.2.) On line 36 of the file, the header, "Image Segmentation Using Color space and Opencv", has been changed to "Segmentation Using Color space and OpenCV" to conform with the OpenCV spelling in the rest of the file.
3.) On line 193, the second-level header has been updated to: "## Pipelines" to improve clarity for contributors.
Screenshots
Please let me know if you have any additional thoughts or concerns, and thank you for reviewing these changes!