Skip to content

Sync legislator/district docstrings with actual signatures#28

Open
c-tonneslan wants to merge 1 commit into
openstates:mainfrom
c-tonneslan:docs/fix-legislator-docstrings
Open

Sync legislator/district docstrings with actual signatures#28
c-tonneslan wants to merge 1 commit into
openstates:mainfrom
c-tonneslan:docs/fix-legislator-docstrings

Conversation

@c-tonneslan

Copy link
Copy Markdown

Refs #20.

Three small docstring drifts in pyopenstates/core.py:

  • get_legislator docstring listed a fields arg the function doesn't take
  • search_districts docstring listed the same phantom fields arg
  • locate_legislators docstring spelled the longitude arg long but the parameter is lng

@jamesturk's note on #20 mentioned the autogen docs still carry v1 leftovers; this is one slice of that.

get_legislator and search_districts don't take fields= args anymore
(they were removed when the v3 calls landed) but the docstrings still
listed them. Drop those, and rename the locate_legislators 'long'
docstring entry to 'lng' to match the parameter name.

Refs openstates#20

Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
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.

1 participant