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 refers to 'Modules' but there's no such concept in Typhoon code #299

Closed
fatuhoku opened this issue Dec 20, 2014 · 5 comments
Closed

Comments

@fatuhoku
Copy link
Contributor

https://github.com/typhoon-framework/Typhoon/wiki/Modules is the source of confusion.

I was wondering if there was a difference between a (Typhoon)Module and a TyphoonAssembly.
I read on to find out that there are no such thing as Modules. Yet the wiki page is titled that way.

If it were titled "How to Modularize Assemblies" would be much better.

@fatuhoku
Copy link
Contributor Author

I would also say that to a new-comer, the concept of a 'Component' is very abstract and is difficult to understand when used in documentation.

In Typhoon, a Component really is just a certain kind of thing in your application.

@jasperblues
Copy link
Member

Thanks so much for the perspective. On mobile right now but wil correct title when I get back to the laptop.

@jasperblues
Copy link
Member

Regarding component: It's meant to meant to refer interchangeably between:

  • a TyphoonDefinition
  • a built instance of anTyphoonDefinition

. . just like a 'bean' in Spring for Java. But it was always implied and never really explained. We'll remove the concept from the docs. And when #253 is finished we will just have assemblies (either built or not) - TyphoonComponentFactory will become a private class.

@jasperblues
Copy link
Member

@fatuhoku

  • Removed all references to 'component'
  • Changed [[Modules]] to [[Modularizing Assemblies]]
  • Added documentation for auto-wiring.

@jasperblues
Copy link
Member

Let's close this, and continue with #300

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

No branches or pull requests

2 participants