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

Consider making the plugin stricter #11

Open
dmitry-timofeev opened this issue Feb 20, 2020 · 0 comments
Open

Consider making the plugin stricter #11

dmitry-timofeev opened this issue Feb 20, 2020 · 0 comments

Comments

@dmitry-timofeev
Copy link
Contributor

dmitry-timofeev commented Feb 20, 2020

Currently the plugin ignores any lines inside the codeinclude section that it does not recognize as include statements (also considering #10). It might result in various typos remaining undetected as the docs build successfully.

Possible issues with the permissive (current) approach:

  • A totally invalid include statement is ignored, a snippet is skipped (likely, rare).
  • An invalid targeting expression is ignored, a whole file is included instead of a particular part (more likely).
  • No matches for a given syntactically correct targeting expression, a whole file is included instead (possibly, separate issue).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant