Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve m.request return value description #2206

Merged
merged 1 commit into from
Jan 25, 2022

Conversation

GAumala
Copy link
Contributor

@GAumala GAumala commented Aug 22, 2018

Description

In the m.request return value description, add a line informing that error status codes cause the promise to reject.

Motivation and Context

This info is already available in the "How it works" section, but if I specifically want to know under what conditions m.request rejects, I'd go straight to the signature description.

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated docs/change-log.md

@GAumala GAumala requested a review from tivac as a code owner August 22, 2018 05:33
In the m.request return value description, add a line informing that
error status codes cause the promise to reject.
@dead-claudia dead-claudia added Area: Documentation For anything dealing mainly with the documentation itself Type: Enhancement For any feature request or suggestion that isn't a bug fix labels Oct 28, 2018
@StephanHoyer StephanHoyer merged commit c075ac7 into MithrilJS:next Jan 25, 2022
@JAForbes JAForbes mentioned this pull request Apr 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation For anything dealing mainly with the documentation itself Type: Enhancement For any feature request or suggestion that isn't a bug fix
Projects
Status: Completed/Declined
Development

Successfully merging this pull request may close these issues.

3 participants