docs(guides/directive): document the C and M directive options #5516
Conversation
|
The meaning of these are documented, for instance at https://github.com/angular/angular.js/blob/master/docs/content/guide/directive.ngdoc#L286 (this is what your patch changes, but it's just a rough example/guide) and https://github.com/angular/angular.js/blob/master/src/ng/compile.js#L205 (the specific API documentation) The documentation generator understands these symbols, and uses them in creating examples (see http://docs.angularjs.org/api/ng.directive:ngClick for an example) It might be good to link to the pertinent API docs from the guide, but I don't necessarily think it's good to duplicate the API docs in the guide, that's all |
|
I think that's reasonable. I've added a link where I'd most expect one to appear |
|
It's a docs fix, and as far as I can tell it's not incorrect or undesirable. Probably get looked at next week in the afternoon, at the latest. |
|
thanks! |
Originally, this issue was regarding documenting `restrict: 'CM'` in the directive guide, but it was pointed out that the restrict documentation is covered in the $compile documentation. Because of this, a link was simply added to the $compile documentation. However, the wording suggests that it's actually linking to the directive registration function, in $compileProvider, so the docs will link there instead. There is a link only a paragraph below to the $compile documentation, so this does not hurt. Closes angular#5516
Originally, this issue was regarding documenting `restrict: 'CM'` in the directive guide, but it was pointed out that the restrict documentation is covered in the $compile documentation. Because of this, a link was simply added to the $compile documentation. However, the wording suggests that it's actually linking to the directive registration function, in $compileProvider, so the docs will link there instead. There is a link only a paragraph below to the $compile documentation, so this does not hurt. Closes angular#5516
I was looking at some code that had:
I had a super hard time figuring out what it did. It would be nice to mention this in the comments.