angular-translate/angular-translate

Doc suggestions for $translate.preferredLanguage and $translate.use

Open

#963 opened on Mar 17, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (4,341 stars) (1,052 forks)batch import
docshelp wantedimprovement

Description

It says "Returns the language key" but language key is a parameter so it is confusing to me. Then is says that is returns the preferred language key. I'm investigating a bug in our code and came across this method. I wonder if having a bit more docs on this method would have helped avoid the bug..

See: http://angular-translate.github.io/docs/#/api/pascalprecht.translate.$translate

preferredLanguage(langKey)

Returns the language key for the preferred language.

Parameters
Param   Type    Details
langKey string  
language String or Array to be used as preferredLanguage (changing at runtime)

Returns
preferred language key

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with AngularJS $translate service
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue requests clarification on the documentation for `$translate.preferredLanguage` and `$translate.use`. The current description says 'Returns the language key' which is ambiguous. The contributor should review the API documentation at https://angular translate.github.io/docs/#/api/pascalprecht.translate.$translate and update the return value description to be more precise, e.g., 'Returns the preferred language key (the key that was set via preferredLanguage())'.