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

fix: record rate doc section #1653

Merged
merged 3 commits into from
Nov 22, 2024
Merged

Conversation

psankhe28
Copy link
Contributor

Checklist

  • A link to the issue/user story that the pull request relates to
  • How to recreate the problem without the fix
  • Design of the fix
  • How to prove that the fix works
  • Automated tests that prove the fix keeps on working
  • Documentation - any JSDoc, website, or Stackoverflow answers?

Issue/User story

#1635

Steps to Reproduce

Existing issues

Design of the fix

Validation of the fix

Automated Tests

What documentation has been provided for this pull request

Signed-off-by: Prati28 <[email protected]>
Copy link
Contributor

@davidkel davidkel left a comment

Choose a reason for hiding this comment

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

Not sure this really addresses the issue here and is also confusing.

  1. For the text format
  • we should just state that the value of i will start at zero, so the first line represents 0 transactions submitted. Each value in a line represents time in milliseconds from the start of the round
  1. For the binary format
  • The first entry length is the total number of transactions submitted (it isn't so far) as it's a final output
  • remove the line that starts if no transactions have been submitted..... this is not correct
  • the subsequent values (Uint32 values in Big Endian or Little Endian format) represent time in milliseconds from the start of the round. Each entry corresponds to the number of transactions submitted starting from 0

Signed-off-by: Prati28 <[email protected]>
@psankhe28 psankhe28 requested a review from davidkel November 16, 2024 17:59
Copy link
Contributor

@davidkel davidkel left a comment

Choose a reason for hiding this comment

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

Some changes required, suggestions are in the comments

docs/source/concepts/rate-controllers.md Outdated Show resolved Hide resolved
docs/source/concepts/rate-controllers.md Show resolved Hide resolved
docs/source/concepts/rate-controllers.md Outdated Show resolved Hide resolved
Signed-off-by: Prati28 <[email protected]>
@psankhe28 psankhe28 requested a review from davidkel November 22, 2024 17:11
Copy link
Contributor

@davidkel davidkel left a comment

Choose a reason for hiding this comment

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

LGTM Many thanks

@davidkel davidkel merged commit 42708e4 into hyperledger-caliper:main Nov 22, 2024
10 checks passed
@psankhe28 psankhe28 deleted the record-rate branch November 24, 2024 19:15
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.

Documentation should state more clearly the rows of record rate and their meaning
2 participants