Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create markdown-links-verifier.yml #3318

Closed
wants to merge 2 commits into from
Closed

Create markdown-links-verifier.yml #3318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
600707b
Create markdown-links-verifier.yml
Youssef1313 Mar 14, 2021
54bc090
Update SA1305.md
Youssef1313 Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/markdown-links-verifier.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Markdown links verifier
Copy link
Member

@sharwell sharwell Mar 15, 2021 •
edited

Choose a reason for hiding this comment

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

📝 For now I'd prefer to not add the action. Can you resubmit just the fixed documentation file as a separate PR? This one can stay closed so future reviewers are aware of its existence.

on: [push, pull_request]

jobs:
validate_links:
name: Markdown links verifier
runs-on: ubuntu-latest

steps:
- name: Checkout the repository
uses: actions/checkout@v1

- name: Validate links
uses: Youssef1313/markdown-links-verifier@v0.0.7
14 changes: 11 additions & 3 deletions documentation/SA1305.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,17 @@ In addition, modern code editors such as Visual Studio make it easy to identify

StyleCop assumes that any variable name that begins with one or two lower-case letters followed by an upper-case letter is making use of Hungarian notation, and will flag a violation of this rule in each case. It is possible to declare certain prefixes as legal, in which case they will be ignored. For example, a variable named *onExecute* will appear to StyleCop to be using Hungarian notation, when in reality it is not. Thus, the *on* prefix should be flagged as an allowed prefix.

To configure the list of allowed prefixes, bring up the StyleCop settings for a project, and navigate to the Hungarian tab, as shown below:

![](Images/HungarianSettings.JPG)
To configure the list of allowed prefixes, use *stylecop.json* like the following:

```json
{
"settings": {
"namingRules": {
"allowedHungarianPrefixes": [ "aa", "bb" ],
},
}
}
```

Adding a one or two letter prefix to this list will cause StyleCop to ignore variables or fields which begin with this prefix.

Expand Down