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

docs: add details about DI mechanism, esp. default providers #1820

Conversation

paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented Aug 12, 2022

What this PR changes/adds

Adds more details about the dependency injection mechanism, in particular about default provider methods.

Why it does that

Default provider methods have been a repeated source for problems due to them being misused. This document should avoid that.

Further notes

  • at some point we'll have to go through the code base and correct usages of default provider methods. A subsequent PR will do that.

Linked Issue(s)

Closes #1806

Checklist

  • added appropriate tests?
  • performed checkstyle check locally?
  • added/updated copyright headers?
  • documented public classes/methods?
  • added/updated relevant documentation?
  • assigned appropriate label? (exclude from changelog with label no-changelog)
  • formatted title correctly? (take a look at the CONTRIBUTING and styleguide for details)

@paullatzelsperger paullatzelsperger added the documentation Improvements or additions to documentation label Aug 12, 2022
@paullatzelsperger paullatzelsperger self-assigned this Aug 12, 2022
@paullatzelsperger paullatzelsperger merged commit 97748f3 into eclipse-edc:main Aug 16, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation about dependency injection, especially default provider methods
3 participants