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

Documentation: Fix typo in docs/reference/koin-core/modules.md #1670

Merged

Conversation

gustavobarbosab
Copy link
Contributor

No description provided.

@arnaudgiuliani arnaudgiuliani self-requested a review October 9, 2023 11:57
@arnaudgiuliani arnaudgiuliani added this to the core-3.5.1 milestone Oct 9, 2023
@@ -253,20 +253,20 @@ startKoin { modules(featureModule1, featureModule2) }
Notice that all modules will be included only once: `dataModule`, `domainModule`, `featureModule1`, `featureModule2`.

:::info
If you have any compiling issue while including modules from the same file, either use `get()` Kotlin attribute operator on your module eitehr separate each moduel in files. See https://github.com/InsertKoinIO/koin/issues/1341 workaround
If you have any compiling issue while including modules from the same file, either use `get()` Kotlin attribute operator on your module either separate each module in files. See https://github.com/InsertKoinIO/koin/issues/1341 workaround
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence reads kinda screwy to me. I think this makes sense and is what the author intended?

Suggested change
If you have any compiling issue while including modules from the same file, either use `get()` Kotlin attribute operator on your module either separate each module in files. See https://github.com/InsertKoinIO/koin/issues/1341 workaround
If you have any compiling issue while including modules from the same file, use the `get()` Kotlin attribute operator on each module. See https://github.com/InsertKoinIO/koin/issues/1341 workaround

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that this note pertains to the creation of modules within the same Kotlin file. This practice can sometimes cause issues in compilation time, and the note intends to inform the developer about it. It recommends separating the modules into distinct files if this kind of problem is happening.

Was this indeed your intention, @arnaudgiuliani?

I think that by changing it like your suggestion, we can lose this information, but if you prefer we can change it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, lets keep to say we have both possibility to use get() or separate file. It's more a IDE/Kotlin compilation stuff problem with our include operator

docs/reference/koin-core/modules.md Outdated Show resolved Hide resolved
Co-authored-by: Kibet Theo <61080898+kibettheophilus@users.noreply.github.com>
@arnaudgiuliani arnaudgiuliani merged commit 64376f9 into InsertKoinIO:3.5.2 Nov 16, 2023
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants