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

DocFx annotations should not use line numbers to reference code snippets #4192

Open
3 tasks
ghost opened this issue Feb 6, 2020 · 1 comment
Open
3 tasks

Comments

@ghost
Copy link

ghost commented Feb 6, 2020

Some of the C# code snippets used in the DocFX markdown are referenced by line number. As discovered in #3711, it is easy to break the documentation when the structure of the referenced code is changed. In parallel with #4169, I'm hoping to resolve the following under issues:

  • Review all line number based code snippets to ensure they are correct
  • Refactor DocFX all line references across .md and .cs files to use #region references
  • Add checks on the build system to warn or fail if line number references are used

Links

@Aaronontheweb
Copy link
Member

Add checks on the build system to warn or fail if line number references are used

I am very excited about that.

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

1 participant