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

UMBRELLA - Refactor List #86

Closed
3 tasks
erogluorhan opened this issue Aug 4, 2022 · 1 comment · Fixed by #370
Closed
3 tasks

UMBRELLA - Refactor List #86

erogluorhan opened this issue Aug 4, 2022 · 1 comment · Fixed by #370
Assignees
Milestone

Comments

@erogluorhan
Copy link
Member

erogluorhan commented Aug 4, 2022

Also mentioned in #88 (comment)

The code base seems to need some refactoring, which can be listed below:

  • Avoid using "Double Leading and Trailing Underscore" with the function and attribute names as they are reserved for Python language's special usage (e.g. __init__ is ok, but def __from_ds__ should better be renamed)
  • Comment/docstring to function name/task inconsistencies (e.g. def __from_ds__(self, dataset)) as well as comment/docstrings cleanup (the same function has both a comment and a docstring in almost same phrases)
  • Avoid wildcard imports as much as possible as they make it hard to know what actual code is being used from those imports (e.g. from .helpers import *)
@anissa111 anissa111 moved this to 📝 To Do in UXarray Development Aug 4, 2022
@philipc2 philipc2 self-assigned this Mar 24, 2023
@philipc2 philipc2 moved this from 📝 To Do to 🏗 In progress in UXarray Development Jun 8, 2023
@philipc2 philipc2 moved this from 🏗 In progress to 📝 To Do in UXarray Development Jun 14, 2023
@philipc2 philipc2 moved this from 📝 To Do to 🏗 In progress in UXarray Development Jun 14, 2023
@philipc2 philipc2 linked a pull request Jul 11, 2023 that will close this issue
7 tasks
@erogluorhan erogluorhan changed the title Refactor UMBRELLA - Refactor List Jul 11, 2023
@philipc2
Copy link
Member

Avoid using "Double Leading and Trailing Underscore" with the function and attribute names as they are reserved for Python language's special usage (e.g. init is ok, but def from_ds should better be renamed)

This will be tackled individually by #378

@philipc2 philipc2 moved this from 🏗 In progress to 👀 In review in UXarray Development Jul 18, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in UXarray Development Jul 21, 2023
@philipc2 philipc2 added this to the Core milestone Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants