call-datetime-without-tzinfo comment (#6105)
## Summary
Updated doc comment for `call_datetime_without_tzinfo.rs`. Online docs
also benefit from this update.
## Test Plan
Checked docs via
[mkdocs](389fe13c93/CONTRIBUTING.md (L267-L296))
This commit is contained in:
@@ -9,6 +9,28 @@ use crate::checkers::ast::Checker;
|
||||
|
||||
use super::helpers;
|
||||
|
||||
/// ## What it does
|
||||
/// Checks for `datetime` instantiations that lack a `tzinfo` argument.
|
||||
///
|
||||
/// ## Why is this bad?
|
||||
/// `datetime` objects are "naive" by default, in that they do not include
|
||||
/// timezone information. By providing a `tzinfo`, a `datetime` can be made
|
||||
/// timezone "aware". "Naive" objects are easy to understand, but ignore some
|
||||
/// aspects of reality, which can lead to subtle bugs.
|
||||
///
|
||||
/// ## Example
|
||||
/// ```python
|
||||
/// import datetime
|
||||
///
|
||||
/// datetime.datetime(2000, 1, 1, 0, 0, 0)
|
||||
/// ```
|
||||
///
|
||||
/// Use instead:
|
||||
/// ```python
|
||||
/// import datetime
|
||||
///
|
||||
/// datetime.datetime(2000, 1, 1, 0, 0, 0, tzinfo=datetime.UTC)
|
||||
/// ```
|
||||
#[violation]
|
||||
pub struct CallDatetimeWithoutTzinfo;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user