docs(voting): fix field names in README to match actual code#60
Open
giwaov wants to merge 2 commits intoarcium-hq:mainfrom
Open
docs(voting): fix field names in README to match actual code#60giwaov wants to merge 2 commits intoarcium-hq:mainfrom
giwaov wants to merge 2 commits intoarcium-hq:mainfrom
Conversation
The Voting README incorrectly referenced field names as 'yes_count' and 'no_count', but the actual VoteStats struct in encrypted-ixs/src/lib.rs uses 'yes' and 'no'. This caused confusion for developers trying to follow the documentation examples. Changes: - Updated all references from yes_count to yes - Updated all references from no_count to no - Affects lines: 80, 101-102, 119, 121, 159 Verified against actual code in: - voting/encrypted-ixs/src/lib.rs (struct VoteStats definition)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixed incorrect field names in Voting README documentation that didn't match the actual code implementation.
Issue
The README used
yes_countandno_countthroughout the documentation, but the actualVoteStatsstruct inencrypted-ixs/src/lib.rsdefines fields asyesandno.This caused confusion for developers trying to follow the code examples.
Changes
yes_count→yesno_count→noFiles Changed
voting/README.md(lines 80, 101-102, 119, 121, 159)Verification
Confirmed against actual struct definition in:
voting/encrypted-ixs/src/lib.rslines 8-11Impact