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

Refactor, cleanup and doc #33

Merged
merged 8 commits into from
Mar 28, 2022
Merged

Refactor, cleanup and doc #33

merged 8 commits into from
Mar 28, 2022

Conversation

cvauclair
Copy link
Contributor

Main changes

  • Add tons of dosctrings comments
  • Remove unneeded code
  • Minor refactoring

subgrounds.client:
- Add docstrings
- Remove dead code
- Remove unneeded imports
subgrounds.client:
- Add docstrings

subgrounds.dataframe_utils:
- Add docstrings

subgrounds.pagination:
- Add docstrings
- Remove unused `flatten` function
- Rename `ArgGeneratorFSM` class to `Cursor`

subgrounds.query:
- Add docstrings
- Rename `Selection.add_selections` to `Selection.add`
- Remove `Selection.add_selection` (now handled by `Selection.add`)
- Rename `Selection.remove_selections` to `Selection.remove`
- Remove `Selection.remove_selection` (now handled by
  `Selection.remove`)
- Rename `Selection.consolidate` to `Selection.merge`
- Add recursive flag to `Selection.contains_argument`
- Change `Selection.get_argument` return type from `Optional[Argument]`
  to `Argument` (now raises exception instead of returning None)
- Change `Selection.get_argument_by_variable` return type from `Optional[Argument]`
  to `Argument` (now raises exception instead of returning None)
- Change `Selection.substitute_arg` to non-static method
- Rename `Query.add_selections` to `Query.add`
- Remove `Query.add_selection` (now handled by `Query.add`)
- Rename `Query.remove_selections` to `Query.remove`
- Remove `Query.remove_selection` (now handled by
  `Query.remove`)
- Change `Query.contains_selection` to non-static method
- Remove unused function `input_value_of_string`
- Remove unused function `input_value_of_value`
- Remove unused function `add_object_field`
- Remove unused function `selection_of_path`
- Remove unused function `pagination_args`

subgrounds.schema:
- Edit docstrings

subgrounds.subgraph:
- Add dosctrings

subgrounds.subgrounds:
- Add dosctrings

subgrounds.transform:
- Add dosctrings

subgrounds.utils:
- Add dosctrings

tests:
- Adapt tests to changes

misc:
- Remove unused `types.py` module
@cvauclair cvauclair added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 28, 2022
@cvauclair cvauclair merged commit cfc5cb5 into main Mar 28, 2022
@cvauclair cvauclair deleted the misc/refactor-cleanup-and-doc branch April 13, 2022 20:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant