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

XXX used as a TODO Label #6342

Closed
Tracked by #6277
mpguerra opened this issue Mar 16, 2023 · 0 comments · Fixed by #6417
Closed
Tracked by #6277

XXX used as a TODO Label #6342

mpguerra opened this issue Mar 16, 2023 · 0 comments · Fixed by #6417
Assignees
Labels
A-docs Area: Documentation C-audit Category: Issues arising from audit findings C-cleanup Category: This is a cleanup

Comments

@mpguerra
Copy link
Contributor

mpguerra commented Mar 16, 2023

It was observed that several annotations in the codebase contain the string XXX and appear to represent a TODO or future task. These items may not be identified or documented via code searches for open issues. Examples include:

/// A very basic retry policy with a limited number of retry attempts.
///
/// XXX Remove this when <https://github.com/tower-rs/tower/pull/414> lands.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub struct RetryLimit {
remaining_tries: usize,
}

// XXX should these constants be split into protocol also?
use crate::protocol::external::types::*;

fn process_message(&mut self, msg: Message) -> Option<Message> {
let mut ignored_msg = None;
// XXX can this be avoided?
let tmp_state = std::mem::replace(self, Handler::Finished(Ok(Response::Nil)));

The above examples are not exhaustive. It is recommended to review the codebase for the XXX tag (or any other similar tag) and align them with a consistent approach to task tracking.

@mpguerra mpguerra added this to Zebra Mar 16, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Zebra Mar 16, 2023
@mpguerra mpguerra added A-docs Area: Documentation C-cleanup Category: This is a cleanup P-Optional ✨ C-audit Category: Issues arising from audit findings labels Mar 16, 2023
@arya2 arya2 self-assigned this Mar 27, 2023
@mergify mergify bot closed this as completed in #6417 Mar 28, 2023
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Zebra Mar 28, 2023
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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants