Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

docs($http): clear up Interceptor docs and code #7460

Closed
wants to merge 1 commit into from
Closed

docs($http): clear up Interceptor docs and code #7460

wants to merge 1 commit into from

Conversation

fwielstra
Copy link
Contributor

Request Type: docs

How to reproduce:

Component(s): $http

Impact: small

Complexity: small

This issue is related to:

Detailed Description:

The documentation and code example of $http interceptors is unclear about whether config can be null
or not, and whether the result should always be a promise or not. This pr clears up the documentation
a bit and removes the literal 'or a promise' interpretation of the docs in the code example.

See #7431

Other Comments:

The documentation and code example of $http interceptors is unclear about whether config can be null
or not, and whether the result should always be a promise or not. This pr clears up the documentation
a bit and removes the literal 'or a promise' interpretation of the docs in the code example.

See #7431
@mary-poppins
Copy link

Thanks for the PR! Please check the items below to help us merge this faster. See the contributing docs for more information.

  • Uses the issue template (#7460)

If you need to make changes to your pull request, you can update the commit with git commit --amend.
Then, update the pull request with git push -f.

Thanks again for your help!

@Narretz
Copy link
Contributor

Narretz commented May 14, 2014

I like that. You could also replace the comments with // modify response object, or even add a meaningful action, such as adding an header for request or isolating a data object for response.

@IgorMinar IgorMinar self-assigned this May 21, 2014
IgorMinar pushed a commit that referenced this pull request May 21, 2014
The documentation and code example of $http interceptors is unclear about whether config can be null
or not, and whether the result should always be a promise or not. This pr clears up the documentation
a bit and removes the literal 'or a promise' interpretation of the docs in the code example.

Closes #7431
Closes #7460
@IgorMinar IgorMinar closed this in 1fe0d99 May 21, 2014
RichardLitt pushed a commit to RichardLitt/angular.js that referenced this pull request May 24, 2014
The documentation and code example of $http interceptors is unclear about whether config can be null
or not, and whether the result should always be a promise or not. This pr clears up the documentation
a bit and removes the literal 'or a promise' interpretation of the docs in the code example.

Closes angular#7431
Closes angular#7460
@fwielstra fwielstra deleted the patch-1 branch October 14, 2014 08:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants