HighFile-scopePython Plug & play

Docstrings required for public APIs (PEP 257 style)

All public modules, classes, and functions must include a docstring immediately after the definition, using PEP 257 conventions (one-line summary + optional sections like Args, Returns, Raises).

Add to Mesrai Open workspace

Why this matters

Baseline documentation improves IDE help, searchability, and onboarding.

Bad vs. good

Side-by-side examples engineers can pattern-match during review.

Avoid

def calculate(a: int, b: int) -> int:
 return a + b

Prefer

def calculate(a: int, b: int) -> int:
 """Return the sum of two integers.

 Args:
 a (int): First addend.
 b (int): Second addend.
 Returns:
 int: a + b.
 """
 return a + b

More snippets

Good

class User:
 """Domain user entity."""
 ...

Bad

class User:
 pass

Related rules

From the same buckets as this rule.

Critical
Avoid Returning Null in Non-Async Task Methods
Returning null from a Task or Task<T> method causes a NullReferenceException if awaited. Use Task.CompletedTask or Task.FromResult<T>(null) instead.
error-handlingreadability-refactor+1
Critical
Prefer `str.replace()` Over `re.sub()` for Simple Cases
Detect uses of `re.sub()` where regular expressions are not needed. For simple string replacements, `str.replace()` is more efficient and should be used instead.
performance-efficiencystack-python+1
Critical
Use Factory Method Injection in `@Configuration` Classes
Ensure that factory method injection is used in `@Configuration` classes instead of `@Autowired` field injection.
module-architecturestyle-conventions

Why this matters

Bad vs. good

More snippets

Related rules

Avoid Returning Null in Non-Async Task Methods

Prefer `str.replace()` Over `re.sub()` for Simple Cases

Use Factory Method Injection in `@Configuration` Classes

Why this matters

Bad vs. good

More snippets

Related rules

Avoid Returning Null in Non-Async Task Methods

Prefer `str.replace()` Over `re.sub()` for Simple Cases

Use Factory Method Injection in `@Configuration` Classes