JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tests.nixpkgs-check-by-name: Fix internal docs

Browse Source
This commit is contained in:
Silvan Mosberger 2024-02-23 02:32:27 +01:00
parent d2fa5bafa9
commit 64da6178bf
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pkgs/test/nixpkgs-check-by-name/src/nix_file.rs
View File

@ -86,7 +86,7 @@ pub struct CallPackageArgumentInfo {
impl NixFile {
/// Returns information about callPackage arguments for an attribute at a specific line/column
/// index.
/// If the location is not of the form `<attr> = callPackage <arg1> <arg2>;`, `Ok(Err(String))` is
/// If the location is not of the form `<attr> = callPackage <arg1> <arg2>;`, `Ok((None, String))` is
/// returned, with String being how the definition looks like.
///
/// This function only returns `Err` for problems that can't be caused by the Nix contents,
@ -109,7 +109,10 @@ impl NixFile {
///
/// You'll get back
/// ```rust
/// Ok(Ok(CallPackageArgumentInfo { path = Some("default.nix"), empty_arg: true }))
/// Ok((
/// Some(CallPackageArgumentInfo { path = Some("default.nix"), empty_arg: true }),
/// "foo = self.callPackage ./default.nix { };",
/// ))
/// ```
///
/// Note that this also returns the same for `pythonPackages.callPackage`. It doesn't make an