Skip to content

Improve CHANGELOG style against mardownlint#432

Merged
wojtekmach merged 1 commit intohexpm:masterfrom
milmazz:changelog
Oct 9, 2017
Merged

Improve CHANGELOG style against mardownlint#432
wojtekmach merged 1 commit intohexpm:masterfrom
milmazz:changelog

Conversation

@milmazz
Copy link
Copy Markdown
Contributor

@milmazz milmazz commented Oct 9, 2017

This PR includes the following changes:

  • Now the first header is a top level (#) header
  • Starting bulleted lists at the beginning of the line
  • Maximum line length is set to 80 columns
  • Headers are now surrounded by blank lines

Also, I added a basic configuration for mardownlint, but it's not necessary to be included in the repo, just let me know what do you think?

@ericmj
Copy link
Copy Markdown
Member

ericmj commented Oct 9, 2017

Hum, I was always told that markdown lists should be indented, that's what we do in Elixir: https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/project.ex#L42. Also the Elixir changelog: https://raw.githubusercontent.com/elixir-lang/elixir/master/CHANGELOG.md.

I don't think the line length should be enforced because I will probably not enforce strictly in the future and I don't really see the point of it.

The rest looks good 👍

@milmazz
Copy link
Copy Markdown
Contributor Author

milmazz commented Oct 9, 2017

I don't think the line length should be enforced because I will probably not enforce strictly in the future and I don't really see the point of it.

I know, we can relax that rule if you want, at least in my case I find it useful to have that limit, that way I avoid to scroll so much in the terminal (e.g. cmd on Windows) or when I split the layout in my editor.

I was always told that markdown lists should be indented

According to the original spec:

List markers typically start at the left margin, but may be indented by up to three spaces. List markers must be followed by one or more spaces or a tab.

But again, we can relax that rule.

@ericmj
Copy link
Copy Markdown
Member

ericmj commented Oct 9, 2017

I know, we can relax that rule if you want, at least in my case I find it useful to have that limit, that way I avoid to scroll so much in the terminal (e.g. cmd on Windows) or when I split the layout in my editor.

Okay, lets enforce it in this PR and I will try to follow to the best of my ability in the future. But no promises :).

But again, we can relax that rule.

I think we indented lists originally because some python markdown renderer required it, but it should not matter in this case so let's dedent.

If you remove the markdownlint file we are good to merge 👍

@milmazz
Copy link
Copy Markdown
Contributor Author

milmazz commented Oct 9, 2017

Okay, lets enforce it in this PR and I will try to follow to the best of my ability in the future. But no promises :).

Thanks!

@wojtekmach wojtekmach merged commit e7294e1 into hexpm:master Oct 9, 2017
@wojtekmach
Copy link
Copy Markdown
Member

Thank you! 😍

ericmj added a commit that referenced this pull request Apr 12, 2026
Refactored the Mint HTTP/2 connection-window patch from a narrow
`:connection_window_size` connect option into a proper public API,
`Mint.HTTP2.set_window_size(conn, target, new_size)`, that supports
both `:connection` and `{:request, ref}` and can be called at any point
after connect. Tracks the receive window in a new `receive_window_size`
field (connection and stream); grow-only; validated to `1..2^31-1`.

This is the function shape that fills a longstanding, well-known gap in
Mint's public API — upstream issue #357 (2022, closed) asked for exactly
this, #432 (2024, still open) is a related enhancement. Ready to submit
upstream as a PR.

On the hex side:

  * Re-vendor from the integration branch (ericmj/hex-vendor-integration)
    which has PR #478 (Elixir 1.12), PR #479 (HTTP/1 1xx handling) and
    the new set_window_size/3 commit all stacked.
  * `Conn.do_connect` now calls `Hex.Mint.HTTP2.set_window_size(conn,
    :connection, 8_000_000)` immediately after a successful HTTP/2 connect.
    No-op on HTTP/1. TCP ordering guarantees the WINDOW_UPDATE reaches the
    server before any request HEADERS, so there's no extra RTT.
  * `:client_settings: [initial_window_size: 8_000_000]` still handles the
    per-stream initial window via SETTINGS.
  * Update `scripts/vendor_mint.sh` comment block to point at the
    integration branch and list all three upstream Mint patches with
    branch links.
ericmj added a commit that referenced this pull request Apr 13, 2026
Refactored the Mint HTTP/2 connection-window patch from a narrow
`:connection_window_size` connect option into a proper public API,
`Mint.HTTP2.set_window_size(conn, target, new_size)`, that supports
both `:connection` and `{:request, ref}` and can be called at any point
after connect. Tracks the receive window in a new `receive_window_size`
field (connection and stream); grow-only; validated to `1..2^31-1`.

This is the function shape that fills a longstanding, well-known gap in
Mint's public API — upstream issue #357 (2022, closed) asked for exactly
this, #432 (2024, still open) is a related enhancement. Ready to submit
upstream as a PR.

On the hex side:

  * Re-vendor from the integration branch (ericmj/hex-vendor-integration)
    which has PR #478 (Elixir 1.12), PR #479 (HTTP/1 1xx handling) and
    the new set_window_size/3 commit all stacked.
  * `Conn.do_connect` now calls `Hex.Mint.HTTP2.set_window_size(conn,
    :connection, 8_000_000)` immediately after a successful HTTP/2 connect.
    No-op on HTTP/1. TCP ordering guarantees the WINDOW_UPDATE reaches the
    server before any request HEADERS, so there's no extra RTT.
  * `:client_settings: [initial_window_size: 8_000_000]` still handles the
    per-stream initial window via SETTINGS.
  * Update `scripts/vendor_mint.sh` comment block to point at the
    integration branch and list all three upstream Mint patches with
    branch links.
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