Skip to content

doc: fix doc style in doc/releases.md #19774

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

Closed
erwinwahyura wants to merge 4 commits into from
Closed

doc: fix doc style in doc/releases.md #19774

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f90ae7c
adding dot in documentations
erwinwahyura Oct 27, 2017
5b147d7
fix doc style
erwinwahyura Apr 3, 2018
790bd4b
Merge branch 'master' into master
erwinwahyura Apr 3, 2018
e3e2bee
fix doc style
erwinwahyura Apr 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions doc/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ commit metadata, as well as the `semver-minor` and `semver-major` GitHub labels.
One drawback is that when the `PR-URL` metadata is accidentally omitted from a
commit, the commit will show up because it's unsure if it's a duplicate or not.

For a list of commits that could be landed in a patch release on v5.x
For a list of commits that could be landed in a patch release on v5.x:

```console
$ branch-diff v5.x master --exclude-label=semver-major,semver-minor,dont-land-on-v5.x --filter-release --format=simple
Expand Down Expand Up @@ -147,8 +147,7 @@ Commits may need to be reverted or a major version bump may need to happen.

#### Step 1: Collecting the formatted list of changes:

Collect a formatted list of commits since the last release. Use
[`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this.
Collect a formatted list of commits since the last release. Use [`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this:
Copy link
Copy Markdown
Member

@Trott Trott Apr 3, 2018

Choose a reason for hiding this comment

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

I'm pretty sure this will fail linting because lines need to be wrapped at 80 characters.


```console
$ changelog-maker --group
Expand Down Expand Up @@ -218,6 +217,8 @@ doc/api/*.md`.

*Note*: `$VERSION` should be prefixed with a `v`

_Note_: `$VERSION` should be prefixed with a `v`.
Copy link
Copy Markdown
Member

@Trott Trott Apr 3, 2018

Choose a reason for hiding this comment

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

The change from * to _ makes this inconsistent with the rest of our docs. Please change it back.

Although... even better perhaps, remove Note: entirely from the line.

Copy link
Copy Markdown
Member

@Trott Trott Apr 3, 2018

Choose a reason for hiding this comment

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

Oh...looks like you added a line rather than editing the existing line. So the line is there twice.

Copy link
Copy Markdown
Contributor Author

@erwinwahyura erwinwahyura Apr 3, 2018

Choose a reason for hiding this comment

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

thats my bad, i will change it back. thank you


If this release includes any new deprecations it is necessary to ensure that
those are assigned a proper static deprecation code. These are listed in the
docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code
Expand Down