diff options
| author | Robert Hensing <robert@roberthensing.nl> | 2022-03-09 14:48:47 +0100 |
|---|---|---|
| committer | Robert Hensing <robert@roberthensing.nl> | 2022-03-09 14:53:53 +0100 |
| commit | 3e39e243db681acf8c0aeeeb8d6a9b27b0f02240 (patch) | |
| tree | e9eccb06551722ad539c999e05880b8a14d18782 /doc | |
| parent | 646e88801113aaa9e2d255853d7de04066440b36 (diff) | |
| download | nixpkgs-3e39e243db681acf8c0aeeeb8d6a9b27b0f02240.tar nixpkgs-3e39e243db681acf8c0aeeeb8d6a9b27b0f02240.tar.gz nixpkgs-3e39e243db681acf8c0aeeeb8d6a9b27b0f02240.tar.bz2 nixpkgs-3e39e243db681acf8c0aeeeb8d6a9b27b0f02240.tar.lz nixpkgs-3e39e243db681acf8c0aeeeb8d6a9b27b0f02240.tar.xz nixpkgs-3e39e243db681acf8c0aeeeb8d6a9b27b0f02240.tar.zst nixpkgs-3e39e243db681acf8c0aeeeb8d6a9b27b0f02240.zip | |
doc/reviewing-contributions: Recommend mkRenamedOptionModuleWith
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing/reviewing-contributions.chapter.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/contributing/reviewing-contributions.chapter.md b/doc/contributing/reviewing-contributions.chapter.md index 0a90781d0c5..7a13a3f3b40 100644 --- a/doc/contributing/reviewing-contributions.chapter.md +++ b/doc/contributing/reviewing-contributions.chapter.md @@ -125,7 +125,7 @@ Reviewing process: - Type should be appropriate (string related types differs in their merging capabilities, `optionSet` and `string` types are deprecated). - Description, default and example should be provided. - Ensure that option changes are backward compatible. - - `mkRenamedOptionModule` and `mkAliasOptionModule` functions provide way to make option changes backward compatible. + - `mkRenamedOptionModuleWith` provides a way to make option changes backward compatible. - Ensure that removed options are declared with `mkRemovedOptionModule` - Ensure that changes that are not backward compatible are mentioned in release notes. - Ensure that documentations affected by the change is updated. |