Skip to content

Commit

Permalink
Merge pull request #381 from votinginfoproject/Bug/Cherry-Pick-Issues…
Browse files Browse the repository at this point in the history 
…-324-379

Bug/cherry pick issues 324 379
  • Loading branch information
@sarahberlin
sarahberlin committed Mar 26, 2019
2 parents 1ae12d9 + e298482 commit 4021697
Show file tree
Hide file tree
Showing 113 changed files with 8,482 additions and 613 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Discussion."
2. if working on a documentation bug/feature, the documentation must build with Sphinx with no
errors (_**NB:** see [Installing Sphinx](#installing-sphinx) below_).
3. Once it's done and tested, create a pull request to move it into the current working branch.
4. Some feedback might be necessary in order to approve a PR. Many members of this repository have substantial technical and election backgrounds, so please take all feedback to heart, regardless of the source. In order to get approval for the pull request, you will need approval from two people, including one representative from Pew and one representative from Google. Pew and Google employees still require two approvers and cannot self-approve, but it is not required that either approver on the PR be from the same organization as the PR author.
4. Some feedback might be necessary in order to approve a PR. Many members of this repository have substantial technical and election backgrounds, so please take all feedback to heart, regardless of the source. In order to get approval for the pull request, you will need approval from two people, including one representative from Democracy Works and one representative from Google. Democracy Works and Google employees still require two approvers and cannot self-approve, but it is not required that either approver on the PR be from the same organization as the PR author.
1. Google approvers: @jdmgoogle
2. Pew approvers: @lbirdpew; @afsmythe; @MariaBianchi
2. Democracy Works approvers: @afsmythe; @sarahberlin
5. When it's reviewed and accepted by the team within a reasonable timeframe (TBD), it's merged
into the current working branch by the developer who created the pull-request.
6. Delete the feature/bug branch.
Expand Down
140 changes: 140 additions & 0 deletions docs/built_rst/csv/elements/ballot_measure_contest.rst
View file

Large diffs are not rendered by default.

47 changes: 47 additions & 0 deletions docs/built_rst/csv/elements/ballot_measure_selection.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.. This file is auto-generated. Do not edit it by hand!
.. _multi-csv-ballot-measure-selection:

ballot_measure_selection
========================

Represents the possible selection (e.g. yes/no, recall/do not recall, et al) for a
:ref:`multi-csv-ballot-measure-contest` that would appear on the ballot.
BallotMeasureSelection extends :ref:`multi-csv-ballot-selection-base`.

+--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+
| Tag | Data Type | Required? | Repeats? | Description | Error Handling |
+==============+===============+==============+==============+==========================================+==========================================+
| selection | ``xs:string`` | **Required** | Single | Selection text for a | If the element is invalid or not |
| | | | | :ref:`multi-csv-ballot-measure-contest` | present, the implementation is required |
| | | | | | to ignore the BallotMeasureSelection |
| | | | | | containing it. |
+--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+

.. code-block:: csv-table
:linenos:
id,sequence_order,selection
bms001,1,Proposition A
bms002,2,Proposition B
.. _multi-csv-ballot-selection-base:

ballot_selection_base
---------------------

A base model for all ballot selection types:
:ref:`multi-csv-ballot-measure-selection`,
:ref:`multi-csv-candidate-selection`, and :ref:`multi-csv-party-selection`.

+----------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+
| Tag | Data Type | Required? | Repeats? | Description | Error Handling |
+================+================+==============+==============+==========================================+==========================================+
| sequence_order | ``xs:integer`` | Optional | Single | The order in which a selection can be | If the field is invalid or not present, |
| | | | | listed on the ballot or in results. This | then the implementation is required to |
| | | | | is the default ordering, and can be | ignore it. |
| | | | | overridden by `OrderedBallotSlectionIds` | |
| | | | | in :ref:`multi-csv-ordered-contest`. | |
+----------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+
32 changes: 32 additions & 0 deletions docs/built_rst/csv/elements/ballot_style.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. This file is auto-generated. Do not edit it by hand!
.. _multi-csv-ballot-style:

ballot_style
============

A container for the contests/measures on the ballot.

+----------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+
| Tag | Data Type | Required? | Repeats? | Description | Error Handling |
+======================+===============+==============+==============+==========================================+==========================================+
| image_uri | ``xs:anyURI`` | Optional | Single | Specifies a URI that returns an image of | If the field is invalid or not present, |
| | | | | the sample ballot. | then the implementation is required to |
| | | | | | ignore it. |
+----------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+
| ordered_contests_ids | ``xs:IDREFS`` | Optional | Single | Reference to a set of | If the field is invalid or not present, |
| | | | | :ref:`multi-csv-ordered-contest` | then the implementation is required to |
| | | | | | ignore it. |
+----------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+
| party_ids | ``xs:IDREFS`` | Optional | Single | Reference to a set of | If the field is invalid or not present, |
| | | | | :ref:`multi-csv-party`s. | then the implementation is required to |
| | | | | | ignore it. |
+----------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+

.. code-block:: csv-table
:linenos:
id,image_uri,ordered_contest_ids,party_ids
bs00010,http://i.giphy.com/26BoCh3PgT8ai45ji.gif,oc2025,par02
bs00011,http://i.giphy.com/3oEjHYDWEICgEpAOjK.gif,oc3000 oc2025,par01
70 changes: 70 additions & 0 deletions docs/built_rst/csv/elements/candidate.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
.. This file is auto-generated. Do not edit it by hand!
.. _multi-csv-candidate:

candidate
=========

The Candidate object represents a candidate in a contest. If a candidate is
running in multiple contests, each contest **must** have its own Candidate
object. Candidate objects may **not** be reused between Contests.

+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| Tag | Data Type | Required? | Repeats? | Description | Error Handling |
+======================+=================================================+==============+==============+==========================================+==========================================+
| ballot_name | ``xs:string`` | **Required** | Single | The candidate's name as it will be | If the element is invalid or not |
| | | | | displayed on the official ballot (e.g. | present, then the implementation is |
| | | | | "Ken T. Cuccinelli II"). | required to ignore the Candidate element |
| | | | | | containing it. |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| contact_information | ``xs:string`` | Optional | Single | Contact and physical address information | If the element is invalid or not |
| | | | | for this Candidate and/or their campaign | present, then the implementation is |
| | | | | (see | required to ignore it. |
| | | | | :ref:`multi-csv-contact-information`). | |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| external_identifiers | :ref:`multi-csv-external-identifiers` | Optional | Single | Another identifier for a candidate that | If the element is invalid or not |
| | | | | links to another source of information | present, then the implementation is |
| | | | | (e.g. a campaign committee ID that links | required to ignore it. |
| | | | | to a campaign finance system). | |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| file_date | ``xs:date`` | Optional | Single | Date when the candidate filed for the | If the field is invalid or not present, |
| | | | | contest. | then the implementation is required to |
| | | | | | ignore it. |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| is_incumbent | ``xs:boolean`` | Optional | Single | Indicates whether the candidate is the | If the field is invalid or not present, |
| | | | | incumbent for the office associated with | then the implementation is required to |
| | | | | the contest. | ignore it. |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| is_top_ticket | ``xs:boolean`` | Optional | Single | Indicates whether the candidate is the | If the field is invalid or not present, |
| | | | | top of a ticket that includes multiple | then the implementation is required to |
| | | | | candidates. | ignore it. |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| party_id | ``xs:IDREF`` | Optional | Single | Reference to a :ref:`multi-csv-party` | If the field is invalid or not present, |
| | | | | element with additional information | then the implementation is required to |
| | | | | about the candidate's affiliated party. | ignore it. |
| | | | | This is the party affiliation that is | |
| | | | | intended to be presented as part of | |
| | | | | ballot information. | |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| person_id | ``xs:IDREF`` | Optional | Single | Reference to a :ref:`multi-csv-person` | If the field is invalid or not present, |
| | | | | element with additional information | then the implementation is required to |
| | | | | about the candidate. | ignore it. |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| post_election_status | :ref:`multi-csv-candidate-post-election-status` | Optional | Single | Final status of the candidate (e.g. | If the field is invalid or not present, |
| | | | | winner, withdrawn, etc...). | then the implementation is required to |
| | | | | | ignore it. |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+
| pre_election_status | :ref:`multi-csv-candidate-pre-election-status` | Optional | Single | Registration status of the candidate | If the field is invalid or not present, |
| | | | | (e.g. filed, qualified, etc...). | then the implementation is required to |
| | | | | | ignore it. |
+----------------------+-------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+

.. code-block:: csv-table
:linenos:
id,ballot_name,external_identifier_type,external_identifier_othertype,external_identifier_value,file_date,is_incumbent,is_top_ticket,party_id,person_id,post_election_status,pre_election_status
can001,Jude Fawley,,,,2016-12-01,true,false,par01,per50001,,filed
can002,Arabella Donn,,,,2016-12-01,false,false,par02,per50002,,qualified
can003,John Coltrane,,,,2016-09-23,false,false,par02,per50003,,qualified
can004,Miles Davis,,,,2016-05-26,false,false,par01,per50004,,qualified

0 comments on commit 4021697

Please sign in to comment.