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

Update I18N documentation #275

Merged
merged 3 commits into from
Jun 29, 2018
Merged

Update I18N documentation #275

merged 3 commits into from
Jun 29, 2018

Conversation

rluba
Copy link
Contributor

@rluba rluba commented Jun 5, 2018

The section about using BaseI18N was outdated:

  • TCustomAttribute already observes language change events and updates itself.
  • Base18N does not respect t-params, causing incorrect translations.

See #273 for details.

The section about using `BaseI18N` was outdated:

* `TCustomAttribute` already observes language change events and updates itself.
* Base18N does not respect `t-params`, causing incorrect translations.

See [issue 273 for details](aurelia#273 (comment))
> Just remember in case you define your own `constructor`, to call `this.super` and pass it the instances of its
dependencies as described in the previous example. Same applies to `attached`, although nothing needs to be passed
in here
Use `i18n.updateTranslation()` to update all translations within the children of the element that is passed to it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually its i18n.updateTranslations()

@zewa666
Copy link
Member

zewa666 commented Jun 6, 2018

I'm not sure whether it's good to simply remove the documentation about the BaseI18N class as it's currently in use. Instead we should show a deprecation notice and that this is going to be removed with the next major release.

@rluba
Copy link
Contributor Author

rluba commented Jun 27, 2018

I thought removing it is the better option since there’s no need to use it anymore (even in the current release) and using it leads to translation errors.

@zewa666
Copy link
Member

zewa666 commented Jun 29, 2018

True, although in combination with what is mentioned here, it might not be that bad. Nevertheless would you mind just updating your PR with the above mentioned typo?

@zewa666 zewa666 merged commit 493768b into aurelia:master Jun 29, 2018
@rluba rluba deleted the patch-1 branch July 28, 2018 14:40
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

Successfully merging this pull request may close these issues.

2 participants