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.

Sign up for GitHub

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

Jump to bottom

Add formatter for markdown tables #2693

Merged
merged 38 commits into from
May 30, 2023
Merged

Add formatter for markdown tables #2693

merged 38 commits into from
May 30, 2023

Conversation

rumyantseva
Copy link
Contributor

@rumyantseva rumyantseva commented May 23, 2023 •
edited
Loading

Description

Closes #1846.

Most of the code in this PR is produced by running task docs-fmt, see the changes in Taskfile.yml.

The changes enforced by prettier:

  • Dashes - are used instead of asterisks * in lists
  • Underscores _ are used instead of asterisks * for italic
  • Unnecessary whitespace are removed automatically
  • The code in markdown is formatted nicely!
  • Links are formatted to follow the same style
  • Tables are formatted

Readiness checklist

  • I added/updated unit tests.
  • I added/updated integration/compatibility tests.
  • I added/updated comments and checked rendering.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I ensured that PR title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@rumyantseva rumyantseva self-assigned this May 23, 2023
@rumyantseva rumyantseva added the code/chore Code maintenance improvements label May 23, 2023
@codecov
Copy link

codecov bot commented May 23, 2023 •
edited
Loading

Codecov Report

Merging #2693 (792e42e) into main (f22f5e1) will decrease coverage by 0.04%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2693      +/-   ##
==========================================
- Coverage   26.23%   26.19%   -0.04%     
==========================================
  Files         441      441              
  Lines       22619    22619              
==========================================
- Hits         5935     5926       -9     
- Misses      16077    16087      +10     
+ Partials      607      606       -1

see 2 files with indirect coverage changes

Flag Coverage Δ
integration 4.96% <ø> (ø)
mongodb 4.96% <ø> (ø)
unit 24.66% <ø> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

@chilagrow chilagrow added documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets blog/engineering Engineering blog posts labels May 23, 2023
@mergify mergify bot requested review from AlekSi, chilagrow, Fashander, noisersup, ptrfarkas, w84thesun and a team May 23, 2023 23:53
@mergify
Copy link
Contributor

mergify bot commented May 23, 2023

Engineering blog posts should be reviewed by other engineers and @Fashander.

@chilagrow chilagrow removed the blog/engineering Engineering blog posts label May 23, 2023
@chilagrow
Copy link
Member

Sorry for the accidental the review request, I just added and removed labels for checking rendering of new formatting 🙈

@chilagrow chilagrow removed documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets labels May 23, 2023
AlekSi
AlekSi reviewed May 24, 2023
View reviewed changes
.markdownlint.yml Outdated Show resolved Hide resolved
@rumyantseva rumyantseva requested a review from Fashander May 30, 2023 11:58
@rumyantseva
Copy link
Contributor Author

I resolved the conflict and checked the rendering, still looks good! Please review again.

w84thesun
w84thesun previously approved these changes May 30, 2023
View reviewed changes
Copy link
Contributor

@w84thesun w84thesun left a comment

Choose a reason for hiding this comment

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

:shipit:

noisersup
noisersup previously approved these changes May 30, 2023
View reviewed changes
@AlekSi AlekSi dismissed stale reviews from noisersup and w84thesun via 46fdc44 May 30, 2023 12:17
@AlekSi AlekSi added documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets labels May 30, 2023
@AlekSi AlekSi requested review from w84thesun, noisersup and a team May 30, 2023 13:12
@AlekSi AlekSi added not ready Issues that are not ready to be worked on; PRs that should skip CI and removed not ready Issues that are not ready to be worked on; PRs that should skip CI labels May 30, 2023
@rumyantseva rumyantseva merged commit 6cca151 into FerretDB:main May 30, 2023
@rumyantseva rumyantseva deleted the issue-1846-table-formatter branch May 30, 2023 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@w84thesun w84thesun w84thesun approved these changes

@AlekSi AlekSi AlekSi approved these changes

@ptrfarkas ptrfarkas Awaiting requested review from ptrfarkas ptrfarkas is a code owner

@b1ron b1ron Awaiting requested review from b1ron b1ron is a code owner automatically assigned from FerretDB/specops

@chilagrow chilagrow Awaiting requested review from chilagrow

@Fashander Fashander Awaiting requested review from Fashander

@noisersup noisersup Awaiting requested review from noisersup

Assignees

@rumyantseva rumyantseva

Labels
code/chore Code maintenance improvements documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets
Projects
Current Engineering
Archived in project
Milestone
v1.3.0
Development

Successfully merging this pull request may close these issues.

Add Markdown linter / formatter for tables
7 participants
@rumyantseva @chilagrow @b1ron @AlekSi @w84thesun @Fashander @noisersup