Skip to content

BSL233 - All public methods must have a description

← All rules

Summary

All public methods must have a description

Identifiers

Field Value
Rule code BSL233
Compatible alias PublicMethodsDescription
Severity INFORMATION
Without configuration Yes
BSLLS JSON, ON mode without overrides Yes
Registry flag implemented Yes
Tags documentation, api

The implemented flag describes the registry; it does not certify verified BSLLS parity.

Behavior

  • The public identifier BSL233 and alias PublicMethodsDescription are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL233"]
ignore = ["PublicMethodsDescription"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL233
  • bsl-disable:
Value = "example";  // bsl-disable: BSL233
  • compatible BSLLS form:
Value = "example";  // BSLLS:PublicMethodsDescription-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL233
// code without this diagnostic
// noqa-enable: BSL233

// bsl-disable: BSL233
// code without this diagnostic
// bsl-enable: BSL233

// BSLLS:PublicMethodsDescription-off
// code without this diagnostic
// BSLLS:PublicMethodsDescription-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

Description

All export methods in the Public region must have a description.

Sources