api-linter icon indicating copy to clipboard operation
api-linter copied to clipboard

feat(AIP-192): Catch unpaired backticks in comments

Open acamadeo opened this issue 2 years ago • 3 comments

Part of #1208

acamadeo avatar Nov 29 '23 02:11 acamadeo

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot https://conventionalcommits.org/

Hey @acamadeo thanks for the contribution. I'm a bit swamped and won't be able to take a deep look this week.

In general though, we have avoided linting specific markdown formatting bugs because we don't want ApiLinter to become a markdown parser. The complexity of the proposed logic for just backticks is an example of why. Personally, I think it would be better if there was a separate tool to validate CommonMark syntax in proto comments, aside from ApiLinter.

noahdietz avatar Nov 29 '23 18:11 noahdietz

No worries, and that makes sense. I'm happy to withdraw the PR if you determine it ends up adding too much complexity to the codebase.

acamadeo avatar Nov 30 '23 17:11 acamadeo