Skip to content

Commit fc4cb85

Browse files
committed
Prefer Python for scripts in developer notes
along with a few miscellaneous touch-ups.
1 parent 370120e commit fc4cb85

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/developer-notes.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -859,12 +859,12 @@ from using a different variable with the same name),
859859
please name variables so that their names do not shadow variables defined in the source code.
860860
861861
When using nested cycles, do not name the inner cycle variable the same as in
862-
the upper cycle, etc.
862+
the outer cycle, etc.
863863
864864
Threads and synchronization
865865
----------------------------
866866
867-
- Prefer `Mutex` type to `RecursiveMutex` one
867+
- Prefer `Mutex` type to `RecursiveMutex` one.
868868
869869
- Consistently use [Clang Thread Safety Analysis](https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) annotations to
870870
get compile-time warnings about potential race conditions in code. Combine annotations in function declarations with
@@ -943,6 +943,8 @@ TRY_LOCK(cs_vNodes, lockNodes);
943943
Scripts
944944
--------------------------
945945
946+
Write scripts in Python rather than bash, when possible.
947+
946948
### Shebang
947949
948950
- Use `#!/usr/bin/env bash` instead of obsolete `#!/bin/bash`.
@@ -1386,7 +1388,7 @@ communication:
13861388
```
13871389
13881390
- For consistency and friendliness to code generation tools, interface method
1389-
input and inout parameters should be ordered first and output parameters
1391+
input and in-out parameters should be ordered first and output parameters
13901392
should come last.
13911393
13921394
Example:

0 commit comments

Comments
 (0)