allianz / ng-aquila

Angular UI Component library for the Open Insurance Platform
https://allianz.github.io/ng-aquila/
Other
209 stars 36 forks source link

Formfield Documentation improvements #10

Closed philip-sultanescu closed 3 years ago

philip-sultanescu commented 3 years ago

Formfield Documentation not clear

This phrase is still confusing for first time readers:

roblems understanding it).

Screenshot 2020-11-25 at 11 04 24

πŸ“– References

https://aposin.github.io/ng-aquila/documentation/formfield/overview

πŸ‘Œ Requirements

Need a clearer description.

Details

This phrase is confusing because it doesn't follow the context of the previous one. "You can import this Formfield module only, but you are required to pass in a nxInput control. So don't try using this import alone."

  1. Consider adding an extra line break <br> above the phrase, to clearly indicate it refers to the import code written below it.
  2. Consider rephrasing to: "Alternatively you could import NxFormfieldModule, but in this case you are required to also add an nxInput control to the html template, like in the Basic Example below."

Using "Alternatively" indicates that you should either use the first import, or the second, but not both as this would give an error related to duplicated imports.