Closed (fixed)
Project:
footermap: a footer site map
Version:
8.x-1.x-dev
Component:
Documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
13 Feb 2020 at 09:10 UTC
Updated:
31 Oct 2020 at 15:49 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
rithesh bk commentedcurrently working on it .....
Comment #3
rithesh bk commentedPlease find the updated patch .......
Comment #4
dhirendra.mishra commented+1 for RTBC..Good work @rithesh
Comment #5
mradcliffeHi, @Rithesh BK, @dhirendra.mishra. Thank you for your looking into this and submitting a patch.
I think that most of the standards in the template apply to README.txt files (non-structured text that needs standards) rather than README.md files (structured text in Markdown format). The README template page mentions for new projects to use the template or projects that use Markdown, to use Markdown that is readable by Markdown Filter module ( See "All about Markdown" ).
I think it would be great if you could revert the changes to Markdown formatting and instead focus on any editing or structural needs. One thing to remember is that line breaks make structural changes in Markdown files. Each line. break becomes a new paragraph. If text needs to be grouped into a paragraph, then it should be kept on one line.
I think that I do like having a one line description of the module come before any sub-headings helps introduce the reader.
Comment #7
mradcliffeI didn't find much to fix up after further review.