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(eslint-plugin): explicit-function-return-type: missing allowFunctionsWithoutTypeParameters sections #6475

Merged
merged 1 commit into from Feb 15, 2023
Merged

Conversation

eranhirsch
Copy link
Contributor

PR Checklist

Overview

#6105 added the allowFunctionsWithoutTypeParameters option to explicit-function-return-type but didn't add additional documentation that would make it more useful to use; the implicit default value (false), and examples of correct and incorrect cases.

This documentation only PR adds the missing pieces.

@nx-cloud
Copy link

nx-cloud bot commented Feb 15, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 7144892. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @eranhirsch!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@netlify
Copy link

netlify bot commented Feb 15, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 7144892
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/63ecb848b4a9930008c94cef
😎 Deploy Preview https://deploy-preview-6475--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@eranhirsch eranhirsch changed the title docs: explicit-function-return-type/allowFunctionsWithoutTypeParameters docs(eslint-plugin): Additional explicit-function-return-type/allowFunctionsWithoutTypeParameters sections Feb 15, 2023
@eranhirsch eranhirsch changed the title docs(eslint-plugin): Additional explicit-function-return-type/allowFunctionsWithoutTypeParameters sections docs(eslint-plugin): explicit-function-return-type: missing allowFunctionsWithoutTypeParameters sections Feb 15, 2023
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

💯 looks perfect. Thanks @eranhirsch! 🙌

@JoshuaKGoldberg JoshuaKGoldberg merged commit fc803cc into typescript-eslint:main Feb 15, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: [explicit-function-return-type] missing allowFunctionsWithoutTypeParameters docs section
2 participants