Add reference documentation for global settings (#5123)

## Summary

Second part of: https://github.com/astral-sh/uv/issues/5093.
This commit is contained in:
Charlie Marsh 2024-07-16 16:50:04 -04:00 committed by GitHub
parent 47e453b01a
commit f7c52fdbfb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 428 additions and 144 deletions

View file

@ -24,9 +24,9 @@ pub struct VirtualEnvironment {
/// A parsed `pyvenv.cfg`
#[derive(Debug, Clone)]
pub struct PyVenvConfiguration {
/// If the `virtualenv` package was used to create the virtual environment.
/// If the virtualenv package was used to create the virtual environment.
pub(crate) virtualenv: bool,
/// If the `uv` package was used to create the virtual environment.
/// If the uv package was used to create the virtual environment.
pub(crate) uv: bool,
}
@ -165,7 +165,7 @@ impl PyVenvConfiguration {
self.virtualenv
}
/// Returns true if the virtual environment was created with the `uv` package.
/// Returns true if the virtual environment was created with the uv package.
pub fn is_uv(&self) -> bool {
self.uv
}