Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meaning and precision of variable names #50

Closed
matthiasschaub opened this issue Jun 9, 2021 · 1 comment
Closed

Meaning and precision of variable names #50

matthiasschaub opened this issue Jun 9, 2021 · 1 comment
Assignees
Labels
brainstorming Idea for a potential new feature or adaption that still needs further discussion comments welcome Indicates that the creator of this PR is open for early review comments

Comments

@matthiasschaub
Copy link
Collaborator

matthiasschaub commented Jun 9, 2021

Sometimes it is not very clear what the a variable means because of confusing naming and/or missing documentation.
See also discussion: #37 (comment)

Some examples:

current variable proposed variable (should) refer to
bpolys bpolys GeojJSON (Feature or FeatureCollection) in CLI/API
bpolys feature GeoJSON (Feature) in oqt.py and indicator/report classes
feature_id fid / feature_id unique value of a certain column
fid_field fid_attrib / feature_id_attribute certain column with unique values
layer / layer_name layer_key key of a layer
layer layer object of the class Layer
indicator / indicator_name indicator_key key of a indicator
indicator indicator object of the class indicator
report / report_name report_key key of a report
report report object of the class report

Also maybe rename 'layer' to 'topic' (see #406)

@matthiasschaub
Copy link
Collaborator Author

Linked to issue #9

@matthiasschaub matthiasschaub added the comments welcome Indicates that the creator of this PR is open for early review comments label Jun 9, 2021
@matthiasschaub matthiasschaub self-assigned this Jan 4, 2022
@matthiasschaub matthiasschaub added the brainstorming Idea for a potential new feature or adaption that still needs further discussion label Jul 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
brainstorming Idea for a potential new feature or adaption that still needs further discussion comments welcome Indicates that the creator of this PR is open for early review comments
Projects
None yet
Development

No branches or pull requests

1 participant