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

Enable line-length lint for markdown docs #1268

Merged

Conversation

ThomsonTan
Copy link
Contributor

Changes

This follows open-telemetry/opentelemetry-dotnet#3049 and enables line-length lint but still disable it for code block and tables where limiting line length reduces readability.

Thanks @reyang to recommendation.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

@ThomsonTan ThomsonTan requested a review from a team March 15, 2022 18:27
@codecov
Copy link

codecov bot commented Mar 15, 2022

Codecov Report

Merging #1268 (a39a28c) into main (49648bd) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1268   +/-   ##
=======================================
  Coverage   92.37%   92.37%           
=======================================
  Files         202      202           
  Lines        7336     7336           
=======================================
  Hits         6776     6776           
  Misses        560      560           

Copy link
Member

@lalitb lalitb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, though not a big fan of MD013 😄. Can we disable this for lines containing URLs too - if possible, else let it be.

@ThomsonTan
Copy link
Contributor Author

Looks good to me, though not a big fan of MD013 😄. Can we disable this for lines containing URLs too - if possible, else let it be.

The line with long URL is already considered by the markdownlint tool.

@lalitb lalitb merged commit 0b1a74c into open-telemetry:main Mar 16, 2022
DebajitDas pushed a commit to DebajitDas/opentelemetry-cpp that referenced this pull request Mar 21, 2022
@ThomsonTan ThomsonTan deleted the enable_line_length_markdownlint branch November 9, 2022 22:56
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

Successfully merging this pull request may close these issues.

3 participants