From b716d641847e6540c26ec24507f614869463cebb Mon Sep 17 00:00:00 2001 From: Paul Robinson <5199899+pacrob@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:13:16 -0600 Subject: [PATCH] fix formatting and some naming in newsfragments (#754) --- newsfragments/621.feature.rst | 2 +- newsfragments/639.feature.rst | 6 +++--- newsfragments/678.misc.rst | 2 +- newsfragments/{679.feature.rst => 679.internal.rst} | 0 newsfragments/681.breaking.rst | 2 +- newsfragments/684.misc.rst | 2 +- newsfragments/690.feature.rst | 2 +- newsfragments/696.bugfix.rst | 4 ++-- newsfragments/701.bugfix.rst | 2 +- newsfragments/702.bugfix.rst | 2 +- newsfragments/{707.feature.rst => 707.internal.rst} | 0 newsfragments/{708.performance.rst => 708.internal.rst} | 0 12 files changed, 12 insertions(+), 12 deletions(-) rename newsfragments/{679.feature.rst => 679.internal.rst} (100%) rename newsfragments/{707.feature.rst => 707.internal.rst} (100%) rename newsfragments/{708.performance.rst => 708.internal.rst} (100%) diff --git a/newsfragments/621.feature.rst b/newsfragments/621.feature.rst index 7ed27fac..f55894f8 100644 --- a/newsfragments/621.feature.rst +++ b/newsfragments/621.feature.rst @@ -1 +1 @@ -Limit concurrency in `push_identify_to_peers` to prevent resource congestion under high peer counts. +Limit concurrency in ``push_identify_to_peers`` to prevent resource congestion under high peer counts. diff --git a/newsfragments/639.feature.rst b/newsfragments/639.feature.rst index 93476b68..f6aa54a6 100644 --- a/newsfragments/639.feature.rst +++ b/newsfragments/639.feature.rst @@ -1,6 +1,6 @@ -Fixed several flow-control and concurrency issues in the `YamuxStream` class. Previously, stress-testing revealed that transferring data over `DEFAULT_WINDOW_SIZE` would break the stream due to inconsistent window update handling and lock management. The fixes include: +Fixed several flow-control and concurrency issues in the ``YamuxStream`` class. Previously, stress-testing revealed that transferring data over ``DEFAULT_WINDOW_SIZE`` would break the stream due to inconsistent window update handling and lock management. The fixes include: - Removed sending of window updates during writes to maintain correct flow-control. - Added proper timeout handling when releasing and acquiring locks to prevent concurrency errors. -- Corrected the `read` function to properly handle window updates for both `read_until_EOF` and `read_n_bytes`. -- Added event logging at `send_window_updates` and `waiting_for_window_updates` for better observability. +- Corrected the ``read`` function to properly handle window updates for both ``read_until_EOF`` and ``read_n_bytes``. +- Added event logging at ``send_window_updates`` and ``waiting_for_window_updates`` for better observability. diff --git a/newsfragments/678.misc.rst b/newsfragments/678.misc.rst index e63e2b95..2d45d482 100644 --- a/newsfragments/678.misc.rst +++ b/newsfragments/678.misc.rst @@ -1 +1 @@ -Refactored gossipsub heartbeat logic to use a single helper method `_handle_topic_heartbeat` that handles both fanout and gossip heartbeats. +Refactored gossipsub heartbeat logic to use a single helper method ``_handle_topic_heartbeat`` that handles both fanout and gossip heartbeats. diff --git a/newsfragments/679.feature.rst b/newsfragments/679.internal.rst similarity index 100% rename from newsfragments/679.feature.rst rename to newsfragments/679.internal.rst diff --git a/newsfragments/681.breaking.rst b/newsfragments/681.breaking.rst index 55050d65..7d5b8f6b 100644 --- a/newsfragments/681.breaking.rst +++ b/newsfragments/681.breaking.rst @@ -1,2 +1,2 @@ -Reordered the arguments to `upgrade_security` to place `is_initiator` before `peer_id`, and made `peer_id` optional. +Reordered the arguments to ``upgrade_security`` to place ``is_initiator`` before ``peer_id``, and made ``peer_id`` optional. This allows the method to reflect the fact that peer identity is not required for inbound connections. diff --git a/newsfragments/684.misc.rst b/newsfragments/684.misc.rst index 0f16fb8f..9957deb7 100644 --- a/newsfragments/684.misc.rst +++ b/newsfragments/684.misc.rst @@ -1 +1 @@ -Uses the `decapsulate` method of the `Multiaddr` class to clean up the observed address. +Uses the ``decapsulate`` method of the ``Multiaddr`` class to clean up the observed address. diff --git a/newsfragments/690.feature.rst b/newsfragments/690.feature.rst index 450ffdfd..f3bcaced 100644 --- a/newsfragments/690.feature.rst +++ b/newsfragments/690.feature.rst @@ -1 +1 @@ -added peer exchange and backoff logic as part of Gossipsub v1.1 upgrade +Added peer exchange and backoff logic as part of Gossipsub v1.1 upgrade diff --git a/newsfragments/696.bugfix.rst b/newsfragments/696.bugfix.rst index d5686418..ba27cc54 100644 --- a/newsfragments/696.bugfix.rst +++ b/newsfragments/696.bugfix.rst @@ -1,4 +1,4 @@ Add timeout wrappers in: -1. multiselect.py: `negotiate` function -2. multiselect_client.py: `select_one_of` , `query_multistream_command` functions +1. ``multiselect.py``: ``negotiate`` function +2. ``multiselect_client.py``: ``select_one_of`` , ``query_multistream_command`` functions to prevent indefinite hangs when a remote peer does not respond. diff --git a/newsfragments/701.bugfix.rst b/newsfragments/701.bugfix.rst index 2bb1be5d..1ef33f0a 100644 --- a/newsfragments/701.bugfix.rst +++ b/newsfragments/701.bugfix.rst @@ -1 +1 @@ -align stream creation logic with yamux specification +Align stream creation logic with yamux specification diff --git a/newsfragments/702.bugfix.rst b/newsfragments/702.bugfix.rst index 90f91f88..f73b45fd 100644 --- a/newsfragments/702.bugfix.rst +++ b/newsfragments/702.bugfix.rst @@ -1 +1 @@ -Fixed an issue in `Pubsub` where async validators were not handled reliably under concurrency. Now uses a safe aggregator list for consistent behavior. +Fixed an issue in ``Pubsub`` where async validators were not handled reliably under concurrency. Now uses a safe aggregator list for consistent behavior. diff --git a/newsfragments/707.feature.rst b/newsfragments/707.internal.rst similarity index 100% rename from newsfragments/707.feature.rst rename to newsfragments/707.internal.rst diff --git a/newsfragments/708.performance.rst b/newsfragments/708.internal.rst similarity index 100% rename from newsfragments/708.performance.rst rename to newsfragments/708.internal.rst