Skip to content

fix: Improve formatting of newlines in markdown files#492

Merged
kodiakhq[bot] merged 2 commits intomainfrom
fix-newlines
Dec 18, 2022
Merged

fix: Improve formatting of newlines in markdown files#492
kodiakhq[bot] merged 2 commits intomainfrom
fix-newlines

Conversation

@hermanschaaf
Copy link
Copy Markdown
Contributor

This neatens the newlines rendered for table docs, so we can no longer get multiple newlines in a row, like here: https://github.com/cloudquery/cloudquery/pull/5547/files#diff-7a51ae50d93ba1ae94ee3a2e3ff898ae0224a0a1cc32cafe0c667ff46cf080e6R1-R8

Closes #454

@github-actions
Copy link
Copy Markdown

⏱️ Benchmark results

Comparing with f995da9

  • DefaultConcurrency-2 resources/s: 11,993 ⬇️ 0.48% decrease vs. f995da9
  • Glob-2 ns/op: 159.2 ⬇️ 23.99% decrease vs. f995da9
  • TablesWithChildrenDefaultConcurrency-2 resources/s: 30,731 ⬆️ 8.08% increase vs. f995da9
  • BufferedScanner-2 ns/op: 9.411 ⬇️ 31.02% decrease vs. f995da9
  • LogReader-2 ns/op: 30.85 ⬇️ 26.84% decrease vs. f995da9

@erezrokah
Copy link
Copy Markdown
Member

Looks great, but if we need more formatting maybe use https://github.com/shurcooL/markdownfmt or https://github.com/DavidAnson/markdownlint with --fix and one of the CLIs it provides

@hermanschaaf
Copy link
Copy Markdown
Contributor Author

@erezrokah Yup, I looked at those, but it would be a fairly big dependency and I think this does what we need for now.

@kodiakhq kodiakhq bot merged commit e48ff90 into main Dec 18, 2022
@kodiakhq kodiakhq bot deleted the fix-newlines branch December 18, 2022 08:02
kodiakhq bot pushed a commit that referenced this pull request Dec 19, 2022
🤖 I have created a release *beep* *boop*
---


## [1.12.6](v1.12.5...v1.12.6) (2022-12-18)


### Bug Fixes

* Add better logging/metric per table ([#513](#513)) ([da36396](da36396))
* Improve formatting of newlines in markdown files ([#492](#492)) ([e48ff90](e48ff90))
* Include table name in logs on panic ([#505](#505)) ([a0b8a46](a0b8a46))
* Move source & destination plugin code to separate packages ([#516](#516)) ([6733785](6733785))
* Use correct error codes ([#514](#514)) ([8b53d76](8b53d76))

---
This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix additional newlines in markdown files

3 participants