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

chore(website): add documentation comments to various functions #6840

Merged
merged 3 commits into from
Apr 5, 2023

Conversation

armano2
Copy link
Member

@armano2 armano2 commented Apr 4, 2023

PR Checklist

Overview

  • add missing documentation comments
  • fix some linting issues
  • small code reorganization
    • there was recently a lot of PR's merged and i think its a good point to reorganize and group functionalities together

…ayground

- fix some linting issues
- small code reorganization
@armano2 armano2 added documentation Documentation ("docs") that needs adding/updating package: website Issues related to the @typescript-eslint website labels Apr 4, 2023
@typescript-eslint
Copy link
Contributor

Thanks for the PR, @armano2!

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 Apr 4, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 662da45
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/642d954eb1de230008f550c4
😎 Deploy Preview https://deploy-preview-6840--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.

@nx-cloud
Copy link

nx-cloud bot commented Apr 4, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 662da45. 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 30 targets

Sent with 💌 from NxCloud.

Object.keys(obj).length -> obj.length
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.

Nice!!

packages/website/src/components/lib/markdown.ts Outdated Show resolved Hide resolved
@armano2 armano2 merged commit c036fe3 into v6 Apr 5, 2023
37 checks passed
@armano2 armano2 deleted the fix/improve-documentation-of-playground branch April 5, 2023 15:48
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating package: website Issues related to the @typescript-eslint website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants