search

Election-Tech-Initiative / electionguard-python

A python module implementing the ElectionGuard specification. This implementation can be used to conduct End-to-End Verifiable Elections as well as privacy-enhanced risk-limiting audits.
https://www.electionguard.vote/
MIT License
162 stars 96 forks source link

🔥 Remove CandidateContestDescription & ReferendumContestDescription #546

Open keithrfung opened 2 years ago

keithrfung commented 2 years ago

Is there an existing issue for this?

Suggestion

CandidateContestDescription, ReferendumContestDescription seem unclear as when and why to use. Perhaps withdraw these from the reference library for now, until they are ready to be developed further?

Possible Implementation

No response

Anything else?

Original issue by @JohnLCaron https://github.com/microsoft/electionguard-python/issues/523

keithrfung commented 2 years ago

I believe these were added for typing but I don't know if they serve a purpose at this current juncture.

Need input from @AddressXception

rc-ms commented 2 years ago

These are simple description fields to include things like instructions on the referendum that aren't explicitly part of the official referendum text. I would prefer to keep and and treat as optional. This is a commonly used field in ballots