-
Notifications
You must be signed in to change notification settings - Fork 27.4k
fixed indentation of input.js comment #6660
fixed indentation of input.js comment #6660
Conversation
Thanks for the PR! Please check the items below to help us merge this faster. See the contributing docs for more information.
If you need to make changes to your pull request, you can update the commit with Thanks again for your help! |
* ngModel.$formatters.push(formatter); | ||
* ``` | ||
* ```js | ||
* function formatter(value) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code within the block needs to have one tab removed so that function lines up with the first back-tick.
Thanks for catching this. I will commit this as soon as the extra tab is removed. |
I'm not sure about this, I think this is probably more of a "dgeni should be less picky about where GFM snippets appear", because lining it up to show that it's a part of the function parameter docs is nice. It will do that anyways in rendering, but it's not obvious looking at the code. |
@caitp - the trouble is that markdown treats indented text as a block of code. Dgeni is clever enough to strip off indentation based on the whitespace at the start of the jsdoc tag but it is not so easy to guess that indentation within a tag is supposed to be stripped. |
You'll notice that Dgeni does not strip off the indentation that has appeared in the other non-code text either:
|
@linclark - thanks for triaging this. If there is a trivial change that's needed before merging then feel free to amend the commit and go ahead and merge. |
@petebacondarwin thanks for commiting :) |
Request Type: docs
How to reproduce:
Component(s): misc core
Impact: small
Complexity: small
This issue is related to:
Detailed Description:
the doc's code block of
$formatter
in http://docs.angularjs.org/api/ng/type/ngModel.NgModelController looks likeSo I fixed indentation of code block in
input.js
Other Comments: