From 1c0e52df39df526d747ddf4ff00e4c40ba5d08e4 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Mon, 17 Jul 2023 16:03:48 +0200 Subject: [PATCH 1/5] Add Cargo feature docs requirement to graduation checklist --- docs/process/graduation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/process/graduation.md b/docs/process/graduation.md index b8983e53130..749b0e6e601 100644 --- a/docs/process/graduation.md +++ b/docs/process/graduation.md @@ -24,6 +24,7 @@ This document contains a checklist for the requirements to migrate a component f - [ ] Every exported function should have docs coverage - [ ] There should be a crate-level example that illustrates a common use case for the component - [ ] All options and conditional code paths should have a corresponding docs test + - [ ] All functions that are conditional on a Cargo feature should say so: `***Enabled with the `"alloc"`Cargo feature***` - [ ] The data structs should fully follow ZeroVec style - [ ] Deserialization should not have a "net violation" in the [verify-zero-copy](https://github.com/unicode-org/icu4x/blob/main/provider/datagen/tests/verify-zero-copy.rs) test - [ ] Constructors should avoid allocating memory in the common case From f7875ccef20daa73600459338a1a13800bee5853 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Mon, 17 Jul 2023 16:04:45 +0200 Subject: [PATCH 2/5] Update graduation.md Fix spacing --- docs/process/graduation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/process/graduation.md b/docs/process/graduation.md index 749b0e6e601..8a910c89db7 100644 --- a/docs/process/graduation.md +++ b/docs/process/graduation.md @@ -24,7 +24,7 @@ This document contains a checklist for the requirements to migrate a component f - [ ] Every exported function should have docs coverage - [ ] There should be a crate-level example that illustrates a common use case for the component - [ ] All options and conditional code paths should have a corresponding docs test - - [ ] All functions that are conditional on a Cargo feature should say so: `***Enabled with the `"alloc"`Cargo feature***` + - [ ] All functions that are conditional on a Cargo feature should say so: `***Enabled with the `"alloc"` Cargo feature***` - [ ] The data structs should fully follow ZeroVec style - [ ] Deserialization should not have a "net violation" in the [verify-zero-copy](https://github.com/unicode-org/icu4x/blob/main/provider/datagen/tests/verify-zero-copy.rs) test - [ ] Constructors should avoid allocating memory in the common case From d4d06582b1c514f052262146310c58478db494f5 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Mon, 17 Jul 2023 16:05:32 +0200 Subject: [PATCH 3/5] Fix formatting --- docs/process/graduation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/process/graduation.md b/docs/process/graduation.md index 8a910c89db7..1ffe017a486 100644 --- a/docs/process/graduation.md +++ b/docs/process/graduation.md @@ -24,7 +24,7 @@ This document contains a checklist for the requirements to migrate a component f - [ ] Every exported function should have docs coverage - [ ] There should be a crate-level example that illustrates a common use case for the component - [ ] All options and conditional code paths should have a corresponding docs test - - [ ] All functions that are conditional on a Cargo feature should say so: `***Enabled with the `"alloc"` Cargo feature***` + - [ ] All functions that are conditional on a Cargo feature should say so: ```***Enabled with the `"alloc"` Cargo feature***``` - [ ] The data structs should fully follow ZeroVec style - [ ] Deserialization should not have a "net violation" in the [verify-zero-copy](https://github.com/unicode-org/icu4x/blob/main/provider/datagen/tests/verify-zero-copy.rs) test - [ ] Constructors should avoid allocating memory in the common case From 1dc49df2659a3ba3b80c28e45ad29a02787779e7 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Sat, 22 Jul 2023 16:46:11 -0700 Subject: [PATCH 4/5] Update graduation.md --- docs/process/graduation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/process/graduation.md b/docs/process/graduation.md index 1ffe017a486..64d8b959d85 100644 --- a/docs/process/graduation.md +++ b/docs/process/graduation.md @@ -22,9 +22,10 @@ This document contains a checklist for the requirements to migrate a component f - [ ] Use `dep:` for enabling dependencies - [ ] The crate should be fully documented - [ ] Every exported function should have docs coverage - - [ ] There should be a crate-level example that illustrates a common use case for the component - - [ ] All options and conditional code paths should have a corresponding docs test - - [ ] All functions that are conditional on a Cargo feature should say so: ```***Enabled with the `"alloc"` Cargo feature***``` + - [ ] There should be a crate-level example that illustrates a common use case for the component with the heading `# Examples` + - [ ] All options and conditional code paths should have a corresponding docs test with the heading `# Examples` + - [ ] All functions that are conditional on a Cargo feature should say so (last line before `# Examples`): ```✨ ***Enabled with the `"alloc"` Cargo feature.***``` + - [ ] Compiled data constructors should say "with compiled data" in the first sentence and should have a Cargo feature alert following the above syntax. - [ ] The data structs should fully follow ZeroVec style - [ ] Deserialization should not have a "net violation" in the [verify-zero-copy](https://github.com/unicode-org/icu4x/blob/main/provider/datagen/tests/verify-zero-copy.rs) test - [ ] Constructors should avoid allocating memory in the common case From e1f612f605516586057d880d3fc41db3e298b5a2 Mon Sep 17 00:00:00 2001 From: "Shane F. Carr" Date: Thu, 27 Jul 2023 11:48:04 -0500 Subject: [PATCH 5/5] Update graduation.md --- docs/process/graduation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/process/graduation.md b/docs/process/graduation.md index 64d8b959d85..8e7c5ef0a36 100644 --- a/docs/process/graduation.md +++ b/docs/process/graduation.md @@ -24,7 +24,7 @@ This document contains a checklist for the requirements to migrate a component f - [ ] Every exported function should have docs coverage - [ ] There should be a crate-level example that illustrates a common use case for the component with the heading `# Examples` - [ ] All options and conditional code paths should have a corresponding docs test with the heading `# Examples` - - [ ] All functions that are conditional on a Cargo feature should say so (last line before `# Examples`): ```✨ ***Enabled with the `"alloc"` Cargo feature.***``` + - [ ] All functions that are conditional on a Cargo feature should say so (last line before `# Examples`): ```✨ *Enabled with the `alloc` Cargo feature.*``` - [ ] Compiled data constructors should say "with compiled data" in the first sentence and should have a Cargo feature alert following the above syntax. - [ ] The data structs should fully follow ZeroVec style - [ ] Deserialization should not have a "net violation" in the [verify-zero-copy](https://github.com/unicode-org/icu4x/blob/main/provider/datagen/tests/verify-zero-copy.rs) test