Skip to content

Markdown linting#1656

Merged
jnyrup merged 5 commits intofluentassertions:masterfrom
eNeRGy164:markdown-linting
Aug 20, 2021
Merged

Markdown linting#1656
jnyrup merged 5 commits intofluentassertions:masterfrom
eNeRGy164:markdown-linting

Conversation

@eNeRGy164
Copy link
Copy Markdown
Contributor

Every time I edited the release notes, Visual Studio Code was showing me a lot of markdown linting warnings.
This PR fixes these warnings.

This improves readability of the markdown files and applies some constructs more consistently.

I addressed:

I added a CSS rule to keep the layout reflecting the original page.
I also added an additional way to easily set up a Ruby development environment on Windows.

@dennisdoomen
Copy link
Copy Markdown
Member

Can you add a screenshot?

@eNeRGy164
Copy link
Copy Markdown
Contributor Author

Of the website?
image

@dennisdoomen dennisdoomen requested a review from jnyrup August 20, 2021 14:13
Copy link
Copy Markdown
Member

@jnyrup jnyrup left a comment

Choose a reason for hiding this comment

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

Out of curiosity, is MD040 triggered by cs or c#?
I mostly use cs instead of csharp and a quick search seems to indicate that vs-code supports cs|csharp|c#

@eNeRGy164
Copy link
Copy Markdown
Contributor Author

eNeRGy164 commented Aug 20, 2021

Out of curiosity, is MD040 triggered by cs or c#?
I mostly use cs instead of csharp and a quick search seems to indicate that vs-code supports cs|csharp|c#

No, MD040 is only triggered if it isn't present. So, I added a value if it wasn't there.
But for all other occurrences I just aligned the value.

@jnyrup jnyrup merged commit a977427 into fluentassertions:master Aug 20, 2021
@eNeRGy164 eNeRGy164 deleted the markdown-linting branch August 24, 2021 08:29
Elanis pushed a commit to Elanis/portfolio that referenced this pull request Dec 13, 2022
Bumps [FluentAssertions](https://github.com/fluentassertions/fluentassertions) from 5.10.3 to 6.1.0.
<details>
<summary>Release notes</summary>

*Sourced from [FluentAssertions's releases](https://github.com/fluentassertions/fluentassertions/releases).*

> ## 6.1.0
> [Release Notes](https://fluentassertions.com/releases/[#610](https://github.com/fluentassertions/fluentassertions/issues/610))
>
> ## 6.0.0
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/master/docs/_pages/releases.md#600)
>
> ## 6.0.0-beta.3
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/6.0.0-beta.3/docs/_pages/releases.md#600-beta-3)
>
> ## 6.0.0-beta.2
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/release-6.0/docs/_pages/releases.md#600-beta-2)
>
> ## 6.0.0-beta.1
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/release-6.0/docs/_pages/releases.md#600-beta-1)
>
> ## 6.0.0-alpha.2
> See [release notes](https://github.com/fluentassertions/fluentassertions/blob/develop/docs/_pages/releases.md#600-alpha-2).
>
> ## 6.0.0-alpha.1
> See https://github.com/fluentassertions/fluentassertions/blob/develop/docs/_pages/releases.md#600
</details>
<details>
<summary>Commits</summary>

- [`ce07e5c`](fluentassertions/fluentassertions@ce07e5c) Bump the release number for 6.1
- [`577d555`](fluentassertions/fluentassertions@577d555) Resolved a significant performance degradation in `BeEquivalentTo` ([#1660](fluentassertions/fluentassertions#1660))
- [`a38a54a`](fluentassertions/fluentassertions@a38a54a) Fix small grammatical error ([#1659](fluentassertions/fluentassertions#1659))
- [`8ad5e52`](fluentassertions/fluentassertions@8ad5e52) Merge pull request [#1658](fluentassertions/fluentassertions#1658) from LennartKoot/async-ex-asserts
- [`559e10b`](fluentassertions/fluentassertions@559e10b) Update release page
- [`f69c87c`](fluentassertions/fluentassertions@f69c87c) Update approved api
- [`1d6b2a3`](fluentassertions/fluentassertions@1d6b2a3) Add extensions method 'WithInnerExceptionExactly()' for async ExceptionAssert...
- [`a977427`](fluentassertions/fluentassertions@a977427) Merge pull request [#1656](fluentassertions/fluentassertions#1656) from eNeRGy164/markdown-linting
- [`d6ea6c1`](fluentassertions/fluentassertions@d6ea6c1) Update header style and add additional installation path
- [`75bfd96`](fluentassertions/fluentassertions@75bfd96) Correct white-space in documentation
- Additional commits viewable in [compare view](fluentassertions/fluentassertions@5.10.3...6.1.0)
</details>

<br />

Reviewed-on: https://gitea.dysnomia.studio/elanis/portfolio/pulls/8
Co-authored-by: elanis <[email protected]>
Co-committed-by: elanis <[email protected]>
Elanis added a commit to Dysnomia-Studio/dehash-me that referenced this pull request Mar 12, 2023
Bumps [FluentAssertions](https://github.com/fluentassertions/fluentassertions) from 5.10.3 to 6.1.0.
<details>
<summary>Release notes</summary>

*Sourced from [FluentAssertions's releases](https://github.com/fluentassertions/fluentassertions/releases).*

> ## 6.1.0
> [Release Notes](https://fluentassertions.com/releases/[#610](https://github.com/fluentassertions/fluentassertions/issues/610))
>
> ## 6.0.0
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/master/docs/_pages/releases.md#600)
>
> ## 6.0.0-beta.3
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/6.0.0-beta.3/docs/_pages/releases.md#600-beta-3)
>
> ## 6.0.0-beta.2
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/release-6.0/docs/_pages/releases.md#600-beta-2)
>
> ## 6.0.0-beta.1
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/release-6.0/docs/_pages/releases.md#600-beta-1)
>
> ## 6.0.0-alpha.2
> See [release notes](https://github.com/fluentassertions/fluentassertions/blob/develop/docs/_pages/releases.md#600-alpha-2).
>
> ## 6.0.0-alpha.1
> See https://github.com/fluentassertions/fluentassertions/blob/develop/docs/_pages/releases.md#600
</details>
<details>
<summary>Commits</summary>

- [`ce07e5c`](fluentassertions/fluentassertions@ce07e5c) Bump the release number for 6.1
- [`577d555`](fluentassertions/fluentassertions@577d555) Resolved a significant performance degradation in `BeEquivalentTo` ([#1660](fluentassertions/fluentassertions#1660))
- [`a38a54a`](fluentassertions/fluentassertions@a38a54a) Fix small grammatical error ([#1659](fluentassertions/fluentassertions#1659))
- [`8ad5e52`](fluentassertions/fluentassertions@8ad5e52) Merge pull request [#1658](fluentassertions/fluentassertions#1658) from LennartKoot/async-ex-asserts
- [`559e10b`](fluentassertions/fluentassertions@559e10b) Update release page
- [`f69c87c`](fluentassertions/fluentassertions@f69c87c) Update approved api
- [`1d6b2a3`](fluentassertions/fluentassertions@1d6b2a3) Add extensions method 'WithInnerExceptionExactly()' for async ExceptionAssert...
- [`a977427`](fluentassertions/fluentassertions@a977427) Merge pull request [#1656](fluentassertions/fluentassertions#1656) from eNeRGy164/markdown-linting
- [`d6ea6c1`](fluentassertions/fluentassertions@d6ea6c1) Update header style and add additional installation path
- [`75bfd96`](fluentassertions/fluentassertions@75bfd96) Correct white-space in documentation
- Additional commits viewable in [compare view](fluentassertions/fluentassertions@5.10.3...6.1.0)
</details>

<br />

Co-authored-by: Elanis <[email protected]>
Reviewed-on: https://gitea.dysnomia.studio/elanis/dehash-me/pulls/14
Co-authored-by: elanis <[email protected]>
Co-committed-by: elanis <[email protected]>
Elanis added a commit to Dysnomia-Studio/dysnomia-website that referenced this pull request Jul 14, 2023
Bumps [FluentAssertions](https://github.com/fluentassertions/fluentassertions) from 5.10.3 to 6.1.0.
<details>
<summary>Release notes</summary>

*Sourced from [FluentAssertions's releases](https://github.com/fluentassertions/fluentassertions/releases).*

> ## 6.1.0
> [Release Notes](https://fluentassertions.com/releases/[#610](https://github.com/fluentassertions/fluentassertions/issues/610))
>
> ## 6.0.0
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/master/docs/_pages/releases.md#600)
>
> ## 6.0.0-beta.3
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/6.0.0-beta.3/docs/_pages/releases.md#600-beta-3)
>
> ## 6.0.0-beta.2
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/release-6.0/docs/_pages/releases.md#600-beta-2)
>
> ## 6.0.0-beta.1
> [Release Notes](https://github.com/fluentassertions/fluentassertions/blob/release-6.0/docs/_pages/releases.md#600-beta-1)
>
> ## 6.0.0-alpha.2
> See [release notes](https://github.com/fluentassertions/fluentassertions/blob/develop/docs/_pages/releases.md#600-alpha-2).
>
> ## 6.0.0-alpha.1
> See https://github.com/fluentassertions/fluentassertions/blob/develop/docs/_pages/releases.md#600
</details>
<details>
<summary>Commits</summary>

- [`ce07e5c`](fluentassertions/fluentassertions@ce07e5c) Bump the release number for 6.1
- [`577d555`](fluentassertions/fluentassertions@577d555) Resolved a significant performance degradation in `BeEquivalentTo` ([#1660](fluentassertions/fluentassertions#1660))
- [`a38a54a`](fluentassertions/fluentassertions@a38a54a) Fix small grammatical error ([#1659](fluentassertions/fluentassertions#1659))
- [`8ad5e52`](fluentassertions/fluentassertions@8ad5e52) Merge pull request [#1658](fluentassertions/fluentassertions#1658) from LennartKoot/async-ex-asserts
- [`559e10b`](fluentassertions/fluentassertions@559e10b) Update release page
- [`f69c87c`](fluentassertions/fluentassertions@f69c87c) Update approved api
- [`1d6b2a3`](fluentassertions/fluentassertions@1d6b2a3) Add extensions method 'WithInnerExceptionExactly()' for async ExceptionAssert...
- [`a977427`](fluentassertions/fluentassertions@a977427) Merge pull request [#1656](fluentassertions/fluentassertions#1656) from eNeRGy164/markdown-linting
- [`d6ea6c1`](fluentassertions/fluentassertions@d6ea6c1) Update header style and add additional installation path
- [`75bfd96`](fluentassertions/fluentassertions@75bfd96) Correct white-space in documentation
- Additional commits viewable in [compare view](fluentassertions/fluentassertions@5.10.3...6.1.0)
</details>

<br />

Co-authored-by: Elanis <[email protected]>
Reviewed-on: https://gitea.dysnomia.studio/elanis/dysnomia-website/pulls/11
Co-authored-by: elanis <[email protected]>
Co-committed-by: elanis <[email protected]>
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