Always add explanatory comments for parameters or configuration options that aren't self-explanatory from their names or context. These comments should explain:
Always add explanatory comments for parameters or configuration options that aren’t self-explanatory from their names or context. These comments should explain:
This helps future developers understand your reasoning and the implications of parameter choices.
Examples:
# Good - explains why retry_on_failures is needed
env.storage_controller.reconcile_until_idle(timeout_secs=60, retry_on_failures=True) # retry_on_failures needed because reconciliation may encounter transient errors during split operations
# Good - explains test parameters
@pytest.mark.parametrize("with_compute_ctl", [False, True], ids=["standard", "compute-ctl"])
# with_compute_ctl: Tests prewarm behavior both with and without compute controller integration
def test_lfc_prewarm(neon_simple_env: NeonEnv, with_compute_ctl: bool):
...
Especially important for:
Enter the URL of a public GitHub repository