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

Describe available fields for engine #58

Closed
qfox opened this issue Feb 13, 2015 · 7 comments
Closed

Describe available fields for engine #58

qfox opened this issue Feb 13, 2015 · 7 comments
Milestone

Comments

@qfox
Copy link
Contributor

qfox commented Feb 13, 2015

Atm readme doesn't provide any information about engines options except some basics.
There are caveats that should be described: https://github.com/enb-bem/enb-bem-tmpl-specs/blob/master/lib/plugin.js#L62-67

@blond
Copy link
Member

blond commented Feb 16, 2015

fixed now?

@qfox
Copy link
Contributor Author

qfox commented Feb 16, 2015

Ops. Not fully. Probably it'd be good to note exportName of options since it's used in lib/plugin.js: https://github.com/enb-bem/enb-bem-tmpl-specs/blob/master/lib/plugin.js#L52

@qfox
Copy link
Contributor Author

qfox commented Feb 16, 2015

For sure the best way here to move these hacks out of code base. In this case we can just note that in code and close the issue.

Off-topic: Also I thought about moving async into tech itself (or to use apply.length to detect it automatically), but it could break something in future.

@blond
Copy link
Member

blond commented Feb 16, 2015

exportName is option of bemhtml tech. Description this option is in the engine packages: enb-bemxjst and enb-xjst. Why to describe it in documentation of this package?

@qfox
Copy link
Contributor Author

qfox commented Feb 16, 2015

@andrewblond Because it's used in code. That's why I want to note these lines in code as hardcoded, make an issue to move these func-ty out, and close this issue. ;-)

@blond
Copy link
Member

blond commented Feb 16, 2015

@zxqfox I don't want to describe exportName in the documentation. If you have an opinion how to get rid of hard code — do it! ;)

@qfox
Copy link
Contributor Author

qfox commented Feb 16, 2015

@andrewblond Okay. Issue for hardcoded exportName: #67

Let's close this!

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