Skip to content

Commit 80d4af0

Browse files
docs: make the native rules testable
N1 now covers every form of the banned phrases, such as ran natively and Comet-native. N2 allows the native shuffle path without pairing it with JVM shuffle. N3 replaces and similar with a test, names user-guide/, and says pages outside the contributor guide allow only the N2 compounds. Agents running the guide could not apply the old wording consistently. Generated-by: OpenCode
1 parent 3a002c1 commit 80d4af0

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

‎docs/source/contributor-guide/style_guide.md‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,19 +84,22 @@ Notes on these terms:
8484
is meant. Name the meaning instead.
8585

8686
- **N1.** Do not use _runs natively_, _natively in Comet_, _the native path_, _the native
87-
pipeline_, _native execution_, _native operator_, or _native Comet operator_. Write _in the Comet
87+
pipeline_, _native execution_, _native operator_, or _native Comet operator_, in any tense or
88+
form, such as _ran natively_, _go native_, _a native path_, or _Comet-native_. Write _in the Comet
8889
pipeline_ (T1) or _Rust-implemented_ (T3).
8990
- **N2.** These compounds are allowed everywhere, because the second part fixes the meaning:
90-
_native Rust_; _native shuffle_ (paired with _JVM shuffle_); "native", optionally followed by a
91-
format, followed by _scan_, _reader_, _write_, or _writer_, for Comet's Rust scans and writers
92-
(_native scan_, _native Parquet reader_, _native Iceberg write_); _native memory_ and _native
93-
library_ (the terms Comet's own log lines use); _Native_ as the expression kind (T6); and
94-
_native implementation_ of an expression, meaning its Rust implementation.
91+
_native Rust_; _native shuffle_ and _the native shuffle path_ (the counterpart of _JVM shuffle_,
92+
which need not appear beside it); "native", optionally followed by a format, followed by _scan_,
93+
_reader_, _write_, or _writer_, for Comet's Rust scans and writers (_native scan_, _native Parquet
94+
reader_, _native Iceberg write_); _native memory_ and _native library_ (the terms Comet's own log
95+
lines use); _Native_ as the expression kind (T6); and _native implementation_ of an expression,
96+
meaning its Rust implementation.
9597
- **N3.** In the contributor guide, "native" before a code noun is also allowed when it means the
96-
crates under `native/` or the JNI boundary: _native code_, _native side_, _native plan_, _native
97-
kernel_, _JVM/native boundary_, and similar. Pages outside the contributor guide, including
98-
`about/`, `index.md`, `README.md`, and `.doc(...)` strings, write _Rust_ instead. N1 applies
99-
everywhere.
98+
crates under `native/` or the JNI boundary: _native code_, _native side_ (and _native-side logs_),
99+
_native plan_, _native kernel_, and _JVM/native boundary_. The noun must name something under
100+
`native/`, such as a crate, file, type, function, or plan, or the JNI boundary. Pages outside the
101+
contributor guide, including `user-guide/`, `about/`, `index.md`, `README.md`, and `.doc(...)`
102+
strings, allow only the N2 compounds and write _Rust_ instead. N1 applies everywhere.
100103
- **N4.** Do not use "native" as a noun. Write _the Rust side_ or name the component: "hands each
101104
block to the Rust side", not "hands each block to native".
102105
- **N5.** Do not call Spark's own behavior native. Write _Spark's built-in shuffle_, not _Spark's

0 commit comments

Comments
 (0)