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.

Sign up for GitHub

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

Jump to bottom

Fix: Change valid-jsdoc to allow returns to be optional for async functions in the requireReturn:false case (fixes #10386) #10480

Merged
merged 1 commit into from Jun 25, 2018
Merged

Fix: Change valid-jsdoc to allow returns to be optional for async functions in the requireReturn:false case (fixes #10386) #10480

merged 1 commit into from Jun 25, 2018

Conversation

Standard8
Copy link
Contributor

What is the purpose of this pull request? (put an "X" next to item)

[ ] Documentation update
[X] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

Original issue: #10386

What changes did you make? (Give an overview)
For async functions with no return statements and requireReturn:false, allow the presence of @returns to be optional.

Is there anything you'd like reviewers to focus on?
Nothing in particular.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Jun 15, 2018
@Standard8
Fix: valid-jsdoc should allow optional returns for async (fixes eslin…
c83ed52 
…t#10386)

Change valid-jsdoc to allow returns to be optional for async functions in the requireReturn:false case.
platinumazure
platinumazure approved these changes Jun 15, 2018
View reviewed changes
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@aladdin-add aladdin-add added bug ESLint is working incorrectly rule Relates to ESLint's core rules evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jun 16, 2018
@not-an-aardvark not-an-aardvark mentioned this pull request Jun 25, 2018
Closed
@not-an-aardvark not-an-aardvark added accepted There is consensus among the team that this change meets the criteria for inclusion patch candidate This issue may necessitate a patch release in the next few days and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jun 25, 2018
not-an-aardvark
not-an-aardvark approved these changes Jun 25, 2018
View reviewed changes
Copy link
Member

@not-an-aardvark not-an-aardvark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@not-an-aardvark not-an-aardvark merged commit 196c102 into eslint:master Jun 25, 2018
matt-riley pushed a commit to matt-riley/gql_boilerplate that referenced this pull request Jun 26, 2018
@greenkeeper @matt-riley
Update eslint to the latest version 🚀 (#8)
088eca3 
## Version **5.0.1** of **[eslint](https://github.com/eslint/eslint)** was just published.

<table>
  <tr>
    <th align=left>
      Dependency
    </th>
    <td>
      <code>[eslint](https://github.com/eslint/eslint)</code>
    </td>
  </tr>
  <tr>
      <th align=left>
       Current Version
      </th>
      <td>
        5.0.0
      </td>
    </tr>
  <tr>
    <th align=left>
      Type
    </th>
    <td>
      devDependency
    </td>
  </tr>
</table>



The version **5.0.1** is **not covered** by your **current version range**.

If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.

It might be worth looking into these changes and trying to get this project onto the latest version of eslint.

If you have a solid test suite and good coverage, a passing build is a strong indicator that you can take advantage of these changes directly by merging the proposed change into your project. If the build fails or you don’t have such unconditional trust in your tests, this branch is a great starting point for you to work on the update.


---


<details>
<summary>Release Notes</summary>
<strong>v5.0.1</strong>

<ul>
<li><a class="commit-link" href="https://urls.greenkeeper.io/eslint/eslint/commit/196c1021c070e52259f2ceccc4f141bdb7456c60"><tt>196c102</tt></a> Fix: valid-jsdoc should allow optional returns for async (fixes <a class="issue-link js-issue-link" data-error-text="Failed to load issue title" data-id="324854620" data-permission-text="Issue title is private" data-url="eslint/eslint#10386" href="https://urls.greenkeeper.io/eslint/eslint/issues/10386">#10386</a>) (<a class="issue-link js-issue-link" data-error-text="Failed to load issue title" data-id="332691684" data-permission-text="Issue title is private" data-url="eslint/eslint#10480" href="https://urls.greenkeeper.io/eslint/eslint/pull/10480">#10480</a>) (Mark Banner)</li>
<li><a class="commit-link" href="https://urls.greenkeeper.io/eslint/eslint/commit/4c823bdf42af8f9a9fcf47473e48a99758881cf4"><tt>4c823bd</tt></a> Docs: Fix max-lines-per-function correct code's max value (<a class="issue-link js-issue-link" data-error-text="Failed to load issue title" data-id="335122700" data-permission-text="Issue title is private" data-url="eslint/eslint#10513" href="https://urls.greenkeeper.io/eslint/eslint/pull/10513">#10513</a>) (Rhys Bower)</li>
</ul>
</details>

<details>
<summary>Commits</summary>
<p>The new version differs by 4 commits.</p>
<ul>
<li><a href="https://urls.greenkeeper.io/eslint/eslint/commit/caeb223c4f7b0b6fe35e5348ae0df4c6446b5bed"><code>caeb223</code></a> <code>5.0.1</code></li>
<li><a href="https://urls.greenkeeper.io/eslint/eslint/commit/125dc34637138b240976f0f76ef53476b15f08b3"><code>125dc34</code></a> <code>Build: changelog update for 5.0.1</code></li>
<li><a href="https://urls.greenkeeper.io/eslint/eslint/commit/196c1021c070e52259f2ceccc4f141bdb7456c60"><code>196c102</code></a> <code>Fix: valid-jsdoc should allow optional returns for async (fixes #10386) (#10480)</code></li>
<li><a href="https://urls.greenkeeper.io/eslint/eslint/commit/4c823bdf42af8f9a9fcf47473e48a99758881cf4"><code>4c823bd</code></a> <code>Docs: Fix max-lines-per-function correct code's max value (#10513)</code></li>
</ul>
<p>See the <a href="https://urls.greenkeeper.io/eslint/eslint/compare/36ced0afca1bc0e1cbbc13cbeaacf9e7cf00841f...caeb223c4f7b0b6fe35e5348ae0df4c6446b5bed">full diff</a></p>
</details>

<details>
  <summary>FAQ and help</summary>

  There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).
</details>

---


Your [Greenkeeper](https://greenkeeper.io) bot 🌴
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Dec 23, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 23, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@platinumazure platinumazure platinumazure approved these changes

@ilyavolodin ilyavolodin ilyavolodin approved these changes

@not-an-aardvark not-an-aardvark not-an-aardvark approved these changes

Assignees
No one assigned
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly patch candidate This issue may necessitate a patch release in the next few days rule Relates to ESLint's core rules
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@Standard8 @platinumazure @ilyavolodin @not-an-aardvark @aladdin-add