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

Switch kwargs to function parameters #42

Open
jmgate opened this issue Apr 25, 2024 · 0 comments
Open

Switch kwargs to function parameters #42

jmgate opened this issue Apr 25, 2024 · 0 comments
Labels
Type: Refactor Refactoring existing code to improve long-term sustainability.

Comments

@jmgate
Copy link
Collaborator

jmgate commented Apr 25, 2024

INSERT DETAILS HERE.

In extending ShellLogger into the more powerful version of itself, **kwargs were used in a number of places to allow for ease of extensibility. As we get closer to open-sourcing, we should re-evaluate each of these usages to see if there are any keyword arguments that should be spelled out explicitly as function parameters. Past experience indicates spelling out everything explicitly hugely improves maintainability, but we definitely didn't take time initially to think through what exactly we wanted all the interfaces to look like. Yay for agile development 😁

  • What needs to be cleaned up?
  • How would the refactored implementation differ from what we have now?
  • What are the potential downsides to not dealing with the technical debt now and leaving it for later?
@jmgate jmgate added the Type: Refactor Refactoring existing code to improve long-term sustainability. label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Refactor Refactoring existing code to improve long-term sustainability.
Projects
None yet
Development

No branches or pull requests

1 participant