Skip to content
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.

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

#361 Issue: Update SetLatencyAndJitter func of Go doc #366

Merged
merged 7 commits into from
May 28, 2024

Conversation

charans29
Copy link
Contributor

Overview

This pull request updates the documentation for the SetLatencyAndJitter function in the knuu package. The previous documentation was outdated and misleading, indicating that only one traffic shaping rule could be set at a time and the function could only be called in the 'Committed' state. However, with the current BitTwister integration, these limitations have been removed.

The updates include:

  • Clarifying that multiple traffic shaping rules such as latency and jitter can now be set simultaneously.
  • Specifying that the function can only be called when the instance is in the 'Started' state.

These changes ensure that the documentation accurately reflects the current capabilities and usage requirements of the SetLatencyAndJitter function.

@MSevey MSevey requested review from smuu and removed request for MSevey May 23, 2024 17:59
@tty47 tty47 requested a review from mojtaba-esk May 24, 2024 07:23
pkg/knuu/instance.go Outdated Show resolved Hide resolved
@mojtaba-esk mojtaba-esk enabled auto-merge May 27, 2024 11:02
@tty47 tty47 disabled auto-merge May 28, 2024 06:55
@tty47 tty47 merged commit 44c3873 into celestiaorg:main May 28, 2024
1 of 2 checks passed
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