tflori / angular-translator

translation module for angular
https://tflori.github.io/angular-translator/
MIT License
21 stars 6 forks source link

documentation for version 2.3 #61

Closed tflori closed 7 years ago

tflori commented 7 years ago

please note that this documentation is supposed to work on github pages. The md files are looking good on github but the links and other stuff may not work correct on github.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling 20662bc5f3c656700f708a267ac6eba3ee0f2b18 on documentation into 00b4abf2182609990e27838c44b9dddac0d772d5 on master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling 20662bc5f3c656700f708a267ac6eba3ee0f2b18 on documentation into 00b4abf2182609990e27838c44b9dddac0d772d5 on master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling 9ed51f882ae1ec26df5fac28a9a79cf78ed7d5e8 on documentation into 00b4abf2182609990e27838c44b9dddac0d772d5 on master.

tflori commented 7 years ago

@BorntraegerMarc can you please review if this is clear enough https://github.com/tflori/angular-translator/blob/documentation/docs/Translator.md

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling c21e84f4907da8e4e00531761f813029f01d50ed on documentation into 00b4abf2182609990e27838c44b9dddac0d772d5 on master.

BorntraegerMarc commented 7 years ago

Looking good. Just one small remark: you have waitForTranslation under sync methods. I understand that you want to inform the user that he needs to call this method before he can access translations.

I just think it is not clear enough that it's a prerequisite and not really a sync method. Maybe you mark it as prerequisite or put it directly in the method calls of instant etc.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling 135ce9c2bea4524d2a54c24bed0083d782c3b51f on documentation into 00b4abf2182609990e27838c44b9dddac0d772d5 on master.