Skip to content

docs(eslint-plugin): [parameter-properties] improve docs #4927

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
Merged
merged 3 commits into from
May 10, 2022
Merged

docs(eslint-plugin): [parameter-properties] improve docs #4927

merged 3 commits into from
May 10, 2022

Conversation

miZyind
Copy link
Contributor

@miZyind miZyind commented May 9, 2022 •
edited
Loading

PR Checklist

Overview

Continue correcting the document according to #4878, #4879.

  • allows => allow
  • parameter-properties => parameter-property

@nx-cloud
Copy link

nx-cloud bot commented May 9, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 575a830. 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 43 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @miZyind!

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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@netlify
Copy link

netlify bot commented May 9, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 575a830
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/627889022f117c0009e64972
😎 Deploy Preview https://deploy-preview-4927--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.

@codecov
Copy link

codecov bot commented May 9, 2022 •
edited
Loading

Codecov Report

Merging #4927 (575a830) into main (47f4605) will increase coverage by 2.49%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #4927      +/-   ##
==========================================
+ Coverage   91.76%   94.25%   +2.49%     
==========================================
  Files         226      153      -73     
  Lines       10586     8305    -2281     
  Branches     3280     2702     -578     
==========================================
- Hits         9714     7828    -1886     
+ Misses        591      263     -328     
+ Partials      281      214      -67
Flag Coverage Δ
unittest 94.25% <100.00%> (+2.49%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...s/eslint-plugin/src/rules/no-restricted-imports.ts 96.42% <100.00%> (-0.07%) ⬇️
...plugin/src/rules/no-unnecessary-type-constraint.ts 88.00% <100.00%> (+3.00%) ⬆️
packages/utils/src/ts-eslint/ESLint.ts
packages/utils/src/ts-eslint/RuleTester.ts
packages/utils/src/ts-eslint/SourceCode.ts
packages/typescript-estree/src/convert.ts
packages/type-utils/src/isUnsafeAssignment.ts
packages/utils/src/ast-utils/eslint-utils/index.ts
packages/utils/src/eslint-utils/RuleTester.ts
packages/type-utils/src/getContextualType.ts
... and 65 more

@dora38 dora38 mentioned this pull request May 9, 2022
Closed
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label May 10, 2022
bradzacher
bradzacher approved these changes May 10, 2022
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

thanks for thsi!

@bradzacher bradzacher changed the title docs(eslint-plugin): improve docs [parameter-properties] docs(eslint-plugin): [parameter-properties] improve docs May 10, 2022
@bradzacher bradzacher merged commit 7275977 into typescript-eslint:main May 10, 2022
@miZyind miZyind deleted the docs/parameter-properties branch May 10, 2022 08:18
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: correct example of parameter-properties
2 participants
@miZyind @bradzacher