Skip to content
This repository has been archived by the owner on Dec 8, 2023. It is now read-only.

The field names in java and python are different #2

Open
maxhutch opened this issue Nov 16, 2016 · 3 comments
Open

The field names in java and python are different #2

maxhutch opened this issue Nov 16, 2016 · 3 comments

Comments

@maxhutch
Copy link
Contributor

Some of the documentation is shared between java and python, but they use different naming conventions. For example, the PifSearchResult has a totalNumHits member in the docs but that is called total_num_hits in the python client.

@kjaym
Copy link
Contributor

kjaym commented Nov 16, 2016

To be consistent with all of the other naming in the python package, the field names are in snake case. Should we just mention that snake case is used throughout the python client?

@maxhutch
Copy link
Contributor Author

Could we do it on each page? I assume users will be landing on the api docs via search, not just reading through them.

@kjaym
Copy link
Contributor

kjaym commented Nov 16, 2016

Of course. Maybe put a star next to field names that have camel case in them and just note under the table what they correspond to in python.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants