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.

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

Markdown: unused definitions found #38549

Closed
xtqqczze opened this issue Jun 29, 2020 · 7 comments · Fixed by #38618
Closed

Markdown: unused definitions found #38549

xtqqczze opened this issue Jun 29, 2020 · 7 comments · Fixed by #38618
Labels
area-Meta help wanted [up-for-grabs] Good issue for external contributors untriaged New issue has not been triaged by the area owner

Comments

@xtqqczze
Copy link
Contributor

> remark --quiet --use lint-no-unused-definitions .
docs\coding-guidelines\clr-code-guide.md
    108:1-108:91  warning  Found unused definition  no-unused-definitions  remark-lint
    241:1-241:98  warning  Found unused definition  no-unused-definitions  remark-lint
    242:1-242:96  warning  Found unused definition  no-unused-definitions  remark-lint
    554:1-554:87  warning  Found unused definition  no-unused-definitions  remark-lint
    719:1-719:89  warning  Found unused definition  no-unused-definitions  remark-lint
    825:1-825:82  warning  Found unused definition  no-unused-definitions  remark-lint
  1146:1-1146:91  warning  Found unused definition  no-unused-definitions  remark-lint

docs\design\coreclr\botr\corelib.md
    290:1-290:90  warning  Found unused definition  no-unused-definitions  remark-lint
    352:1-352:86  warning  Found unused definition  no-unused-definitions  remark-lint

docs\design\features\source-generator-pinvokes.md
    217:1-217:67  warning  Found unused definition  no-unused-definitions  remark-lint

docs\project\glossary.md
    353:1-353:39  warning  Found unused definition  no-unused-definitions  remark-lint
    354:1-354:62  warning  Found unused definition  no-unused-definitions  remark-lint

‼ 12 warnings
@Dotnet-GitSync-Bot Dotnet-GitSync-Bot added area-Meta untriaged New issue has not been triaged by the area owner labels Jun 29, 2020
@jkotas jkotas added the help wanted [up-for-grabs] Good issue for external contributors label Jun 29, 2020
@danmoseley
Copy link
Member

@xtqqczze do you want to offer a PR? I thought I got the markdown clean, but maybe it's regressed or you have a different linter.

@xtqqczze
Copy link
Contributor Author

@danmosemsft I used remark-lint-no-unused-definitions. Does the repo currently run any linters on CI?

@danmoseley
Copy link
Member

Not for markdown. But we could, if it was easy and reliable (and flagged impactful issues eg broken links)
Maybe https://github.com/github/super-linter could help?

@xtqqczze
Copy link
Contributor Author

xtqqczze commented Jun 30, 2020

@danmosemsft I have two PRs to resolve these linter warnings:

@xtqqczze
Copy link
Contributor Author

@danmosemsft super-linter looks like it has a lot of dependencies, we could just use an action based on markdownlint-cli (this is what super-linter does).

@danmoseley
Copy link
Member

@xtqqczze as mentioned above, to add a linter it would at a minimum have to be totally reliable, and it would have to flag issues we care about (some markdown lint issues are things like inconsistent indent of headings which make no visual difference). If you think we should consider markdownlint-cli perhaps you could open a new issue to discuss.

@xtqqczze
Copy link
Contributor Author

We would first need to replace invalid inline HTML like <a name="register" /> (see #38619). Otherwise, we cannot be sure to avoid false positives.

@ghost ghost locked as resolved and limited conversation to collaborators Dec 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Meta help wanted [up-for-grabs] Good issue for external contributors untriaged New issue has not been triaged by the area owner
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants