openstack/horizon
Code Issues Proposed changes

Small fix to angular docs

Browse Source 
Removing outdated docs since we are now adopting JP's style guide.

Change-Id: I6766027addeaaa04756a478d07dc37fd4307907f
Closes-bug: #1458938
This commit is contained in:
Thai Tran
2015-05-26 13:45:02 -07:00
parent 46ca8a7095
commit c16b271a2b
1 changed files with 17 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
doc/source/contributing.rst
View File

@@ -394,58 +394,43 @@ required and recommended sections.
Required Required
~~~~~~~~ ~~~~~~~~
* Organization: Define your Angular app under the root Angular folder (such
as ``horizon/static/horizon/js/angular/hz.table.js``).
* Controllers and Services should not contain DOM references. Directives
should.
* Services are singletons and contain logic independent of view.
* Scope is not the model (model is your JavaScript Objects). The scope * Scope is not the model (model is your JavaScript Objects). The scope
references the model. Use isolate scopes wherever possible. references the model. Use isolate scopes wherever possible.
* https://github.com/angular/angular.js/wiki/Understanding-Scopes * https://github.com/angular/angular.js/wiki/Understanding-Scopes
* Read-only in templates. * Read-only in templates.
* Write-only in controllers. * Write-only in controllers.
* Since Django already uses ``{{ }}``, use ``{$ $}`` or ``{% verbatim %}`` * Since Django already uses ``{{ }}``, use ``{$ $}`` or ``{% verbatim %}``
instead. instead.
* For localization in Angular files, use the Angular service horizon.framework.util.i18n.gettext.
For regular Javascript files, use either ``gettext`` or ``ngettext``. * For localization in Angular files, use the Angular service
Only those two methods are recognized by our tools and will be included in horizon.framework.util.i18n.gettext. Ensure that the injected dependency
the .po file after running ``./run_tests --makemessages``. is named ``gettext``. For regular Javascript files, use either ``gettext`` or
``ngettext``. Only those two methods are recognized by our tools and will be
included in the .po file after running ``./run_tests --makemessages``.
.. code :: .. code ::
// Angular // Angular
angular.module('horizon.framework.widgets.modal', ['ui.bootstrap', 'horizon.framework.util.i18n']) angular.module('myModule')
.factory('horizon.framework.widgets.modal.service', ['$modal', 'basePath', 'horizon.framework.util.i18n.gettext', .factory('myFactory', myFactory);
function($modal, path, gettext) { gettext('translatable text'); };
// recognized myFactory.$inject = ['horizon.framework.util.i18n.gettext'];
function myFactory(gettext) {
gettext('translatable text');
}
// Javascript
gettext("translatable text"); gettext("translatable text");
ngettext("translatable text"); ngettext("translatable text");
// not recognized // Not valid
var _ = gettext; var _ = gettext;
_('translatable text'); _('translatable text');
$window.gettext('translatable text'); $window.gettext('translatable text');
Recommended
~~~~~~~~~~~
* Put "Ctrl" on the end of a controller file name.
* Don't use variables like "app" that are at the highest level in the file,
when Angular gives an alternative. For example use function chaining:
.. code ::
angular.module('my_module')
.controller('my_controller', ['$scope', function($scope) {
// controller code
}]).service('my_module.my_service', ['$scope', function($scope) {
// service code
}]);
JSHint JSHint
------ ------