Documentation: Tsdoc comments in whole codebase

[gautam-divyanshu]

What kind of change does this PR introduce?

Issue Number:

Fixes #2114

Did you add tests for your changes?
No

Snapshots/Videos:

Have you read the contributing guide?

[github-actions]

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

1. The overall code coverage drops below the target threshold of the repository
2. Any file in the pull request has code coverage levels below the repository threshold
3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[coderabbitai]

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

106 files out of 158 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[gautam-divyanshu]

@palisadoes I wrote comments in those files that have eslint errors already because of any. This is causing the test application workflow to get skipped.

[gautam-divyanshu]

I disabled them because I couldn't commit changes without doing so.

[gautam-divyanshu]

I won't be able to remove any type because there may not be other options; that's why they are there.

[gautam-divyanshu]

test cases in develop branch

in my pr

[gautam-divyanshu]

@palisadoes So what should I do?

[gautam-divyanshu]

@palisadoes any suggestions?

[palisadoes]

We merged some updated packages recently. That may be the cause.

• https://github.com/PalisadoesFoundation/talawa-admin/pulls?q=is%3Apr+is%3Aclosed

[palisadoes]

The error explains what is wrong. We need to make sure the linting in those files is fixed.

• https://github.com/PalisadoesFoundation/talawa-admin/actions/runs/10081496851/job/27873822034?pr=2113

[gautam-divyanshu]

@palisadoes I can try to fix, but mostly can't be fixed

[gautam-divyanshu]

@palisadoes I need to disable some linting errors, so what should I do?

[palisadoes]

Do what you can. We shouldn't disable linting. I'll see if I can force merge when you are done.

[palisadoes]

Please fix the conflicting files.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.48%. Comparing base (fc70a6d) to head (b9cea01).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2113   +/-   ##
========================================
  Coverage    97.48%   97.48%           
========================================
  Files          233      233           
  Lines         6551     6559    +8     
  Branches      1919     1926    +7     
========================================
+ Hits          6386     6394    +8     
  Misses         150      150           
  Partials        15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gautam-divyanshu]

@palisadoes we can merge this PR now.