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

Refactor code to make it more readable #209

Closed
demeringo opened this issue Jan 11, 2023 · 0 comments · Fixed by #445
Closed

Refactor code to make it more readable #209

demeringo opened this issue Jan 11, 2023 · 0 comments · Fixed by #445
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@demeringo
Copy link
Collaborator

Problem

The naming of some functions is not clear, some methods or structs could benefit from renaming.

Solution

  • Things mentioning default_impacts (like print_default_impacts_as_json) could be simplified as we now have a single way to get impacts. No need to mention default anymore.
  • standard_scan -> estimate (like in cli ?)
  • use the same naming between sls routes and metric server ?

CLI options:

the --as-metric option should be a sub-option of the estimate command (not a top level option), basically it it here to precise the format of the estimate to return. something like format: (json|openmetrics) could be better.

hours-use-time parameter could be renamed into use-duration-hours

Not sure about filter-tags... but we should convey the idea that only the resources with tags mentioned will be included

Alternatives

Additional context or elements

@demeringo demeringo added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 11, 2023
@demeringo demeringo self-assigned this Feb 26, 2024
@demeringo demeringo linked a pull request Feb 26, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant