search

nixpkgs-architecture / pkgs-modules

Working group for using modules for packages
Creative Commons Attribution Share Alike 4.0 International
25 stars 3 forks source link

feat(use cases): Add "Good Error Messages" #16

Closed DavHau closed 1 year ago

DavHau commented 1 year ago

This PR enhances the use case documentation for "Good Error Messages", providing a concrete example and outlining the current issues. This serves as a guidepost for future improvement initiatives in error messaging within the Nix ecosystem.

closes https://github.com/nixpkgs-architecture/pkgs-modules/issues/6

infinisil commented 1 year ago

I'm thinking this is a goal rather than a use case, and thinking about how the two relate to each other, I think that our goal should be to fix the problems of the use cases.

How about moving this to a problems directory, then linking this item to that file: https://github.com/nixpkgs-architecture/pkgs-modules/blob/ac18343757b5182d2d749748723215261e5ff5c0/use-cases/Customizing%20a%20package%20definition.md#L36

infinisil commented 1 year ago

Oh I see, #18 was a PR against this branch :smile:

DavHau commented 1 year ago

Moved the file and added a link from the customization document.

DavHau commented 1 year ago

Via https://github.com/nixpkgs-architecture/pkgs-modules/pull/16/commits/d5ee0cdfc023c261724912d21d200ccce79cbef0 I removed the following statement from the General Information section:

For instance, if a package fails to build due to a missing dependency, the error message should clearly identify the missing dependency and where it's expected.

... as this is more like a build time logic problem and I'm not sure if this is in scope for us.