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

Make fields/parameter names more clear #261

Open
LukaszKontowski opened this issue Aug 22, 2022 · 2 comments
Open

Make fields/parameter names more clear #261

LukaszKontowski opened this issue Aug 22, 2022 · 2 comments
Labels
good first issue Good for newcomers

Comments

@LukaszKontowski
Copy link
Contributor

There are some confusing / unclear parameter names in the source code. For example:

final case class DependencyProvider(
    intelliJ: IntelliJDependencyProvider,
    plugin: PluginDependencyProvider,
    jbr: JbrDependencyProvider
)

Where we have plugin: PluginDependencyProvider and later on we have following method call in the code:
val file = dependencies.plugin.fetch(plugin)
Where first plugin refers to the PluginDependencyProvider type and second one to an object of Plugin type. There are more cases like this one. We should rename such fields / parameters for better code readability.

@LukaszKontowski LukaszKontowski added the good first issue Good for newcomers label Aug 22, 2022
@PawelLipski
Copy link
Contributor

Note that we need to be considerate wrt. backward compatibility of the HOCON config when doing any such renames 🤔

@LukaszKontowski
Copy link
Contributor Author

Sure, special care for parameter names used by the IdeProbeConfig and its fields.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants