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.

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

Jump to bottom

Updathe go doc for SetLatencyAndJitter func #361

Closed
mojtaba-esk opened this issue May 22, 2024 · 0 comments
Closed

Updathe go doc for SetLatencyAndJitter func #361

mojtaba-esk opened this issue May 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers knuu

Comments

@mojtaba-esk
Copy link
Contributor

mojtaba-esk commented May 22, 2024 •
edited
Loading

The current go doc for the following function is misleading users as it is outdated.

func (i *Instance) SetLatencyAndJitter(latency, jitter int64) error

The doc indicates that user can set only one of the traffic shaping rules at a time which was a limitation of the very first BitTwister integration. That limitation is no longer the case. so we need to fix it.

more context: https://celestia-team.slack.com/archives/C0653SYL6GM/p1716389298931399
@mojtaba-esk mojtaba-esk added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 22, 2024
tty47 added a commit that referenced this issue May 28, 2024
@charans29 @tty47
#361 Issue: Update SetLatencyAndJitter func of Go doc (#366)
44c3873 
* doc Update on SetLatencyAndJitter func

* Update on SetLatencyAndJitter func doc

* doc update with example

---------

Co-authored-by: Jose Ramon Mañes <[email protected]>
@smuu smuu added the knuu label Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers knuu
Projects
Celestia DevOps/Testing
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mojtaba-esk @smuu