Document the RequiresPython fields (#4798)
This commit is contained in:
@@ -25,7 +25,14 @@ pub enum RequiresPythonError {
|
||||
/// See: <https://packaging.python.org/en/latest/guides/dropping-older-python-versions/>
|
||||
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
|
||||
pub struct RequiresPython {
|
||||
/// The supported Python versions as provides by the user, usually through the `requires-python`
|
||||
/// field in `pyproject.toml`.
|
||||
///
|
||||
/// For a workspace, it's the union of all `requires-python` fields in the workspace. If no
|
||||
/// bound was provided by the user, it's greater equal the current Python version.
|
||||
specifiers: VersionSpecifiers,
|
||||
/// The lower bound from the `specifiers` field, i.e. greater or greater equal the lowest
|
||||
/// version allowed by `specifiers`.
|
||||
bound: RequiresPythonBound,
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user