github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-31 08:28:34 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3286 from zmlcc/pr-advice-expect-211216

Browse Source 
docs: Update code PR advice document
This commit is contained in:
Jakob Naucke
2021-12-17 15:35:05 +01:00
committed by GitHub
parent 39cf2b27c1 02608e13ab
commit 7fdb425918
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/code-pr-advice.md
View File

@@ -198,6 +198,7 @@ The table below lists the small number of cases where use of
| `defer!()` | Similar to golang's `defer()` but doesn't allow the use of `?`. |
| `tokio::spawn(async move {})` | Cannot currently return a `Result` from an `async move` closure. |
| If an explicit test is performed before the `unwrap()` / `expect()` | *"Just about acceptable"*, but not ideal `[*]` |
| `Mutex.lock()` | Almost unrecoverable if failed in the lock acquisition |
`[*]` - There can lead to bad *future* code: consider what would