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

DOC105: Prefer paramref to inline code #24

Closed
sharwell opened this issue Sep 15, 2018 · 2 comments
Closed

DOC105: Prefer paramref to inline code #24

sharwell opened this issue Sep 15, 2018 · 2 comments
Assignees
Milestone

Comments

@sharwell
Copy link
Member

sharwell commented Sep 15, 2018

Offer to convert <c>param</c> to <paramref name="param"/>.

Related to #25

@jnm2
Copy link

jnm2 commented Sep 15, 2018

I more often see someParam used without <c>. Could we detect camel-cased words that exactly match a parameter and suggest the same thing?

@sharwell
Copy link
Member Author

@jnm2 it's possible, but I'd want to separate it similar to #5/#6.

@sharwell sharwell changed the title Use paramref when appropriate Prefer paramref to inline code Sep 15, 2018
@sharwell sharwell changed the title Prefer paramref to inline code DOC105: Prefer paramref to inline code Sep 19, 2018
@sharwell sharwell added this to the 1.0.0 Beta milestone Sep 20, 2018
sharwell added a commit to sharwell/DocumentationAnalyzers that referenced this issue Sep 21, 2018
@sharwell sharwell self-assigned this Sep 21, 2018
sharwell added a commit to sharwell/DocumentationAnalyzers that referenced this issue Sep 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants