Skip to content

Generated Guidelines XML from the CSV file - #125

Merged
Keboo merged 2 commits into
IntelliTect:masterfrom
frosch95:EssentialCSharpGuidelinesXML
Oct 3, 2020
Merged

Generated Guidelines XML from the CSV file#125
Keboo merged 2 commits into
IntelliTect:masterfrom
frosch95:EssentialCSharpGuidelinesXML

Conversation

@frosch95

Copy link
Copy Markdown
Contributor

Closes#123

Comment threaddocs/Guidelines(8th Edition).xml Outdated
<root>
<guideline key="Ch01_fa67753" severity="DO" section="Naming" subsection="Variables and fields">DO favor clarity over brevity when naming identifiers.</guideline>
<guideline key="Ch01_674fe1e" severity="DO NOT" section="Naming" subsection="Abbreviations">DO NOT use abbreviations or contractions within identifier names.</guideline>
<guideline key="Ch01_024aa0c" severity="UNKNOWN ARGL" section="Naming" subsection="Abbreviations">"DO NOT use any acronyms unless they are widely accepted, and even then use them consistently."</guideline>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the severity on several of these items is set to UNKNOWN ARGL. From looking over the items it appears that it is likely caused by the leading quotation marks

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Keboo oh you are right, with the quotes the automatic recognition of the severtiy didn't work correctly. I will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Keboo done

@KebooKeboo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you.

@KebooKeboo added the documentation Improvements or additions to documentation label Oct 3, 2020
@Keboo
Keboo merged commit f98b43a into IntelliTect:masterOct 3, 2020
@frosch95

Copy link
Copy Markdown
ContributorAuthor

You are welcome :-)

@frosch95
frosch95 deleted the EssentialCSharpGuidelinesXML branch October 3, 2020 16:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Convert existing csv into xml

2 participants

@frosch95@Keboo