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

change(docs): Replaces XXX with TODO #6417

Merged
merged 2 commits into from
Mar 28, 2023
Merged

change(docs): Replaces XXX with TODO #6417

merged 2 commits into from
Mar 28, 2023

Conversation

arya2
Copy link
Contributor

@arya2 arya2 commented Mar 27, 2023

Motivation

Annotations in the codebase that contain the string XXX and appear to represent a TODO or future task may not be identified or documented via code searches for open issues.

Closes #6342.

Solution

  • Replace "XXX" with "TODO:" where applicable

Review

Optional priority, anyone can review.

Reviewer Checklist

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
    • Does it change concurrent code, unsafe code, or consensus rules?
  • How do you know it works? Does it have tests?

@arya2 arya2 requested review from a team as code owners March 27, 2023 22:05
@arya2 arya2 requested review from teor2345 and removed request for a team March 27, 2023 22:05
@github-actions github-actions bot added the C-enhancement Category: This is an improvement label Mar 27, 2023
@arya2 arya2 added A-docs Area: Documentation C-cleanup Category: This is a cleanup P-Optional ✨ C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG C-audit Category: Issues arising from audit findings labels Mar 27, 2023
@arya2 arya2 self-assigned this Mar 27, 2023
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

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

@arya2 arya2 requested a review from oxarbitrage March 27, 2023 22:53
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

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

thanks!

@codecov
Copy link

codecov bot commented Mar 27, 2023

Codecov Report

Merging #6417 (f5100ca) into main (8ba3fd9) will decrease coverage by 0.14%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6417      +/-   ##
==========================================
- Coverage   77.79%   77.66%   -0.14%     
==========================================
  Files         304      304              
  Lines       39585    39585              
==========================================
- Hits        30797    30745      -52     
- Misses       8788     8840      +52     

mergify bot added a commit that referenced this pull request Mar 28, 2023
@mergify mergify bot merged commit 083ddea into main Mar 28, 2023
@mergify mergify bot deleted the update-xxx-todos branch March 28, 2023 04:13
@mpguerra mpguerra mentioned this pull request Mar 28, 2023
36 tasks
@arya2 arya2 mentioned this pull request Apr 18, 2023
36 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-audit Category: Issues arising from audit findings C-cleanup Category: This is a cleanup C-enhancement Category: This is an improvement C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG
Projects
None yet
Development

Successfully merging this pull request may close these issues.

XXX used as a TODO Label
2 participants