Consumer mismatch

Business ruleSpace Specifications

An API (note: API) declares a consumer (6 passages, no note) that never cites (31 passages, no note) it, or a note cites (6 passages, no note) an API that does not list it. One of the two is out of date (44 passages, no note). A declared consumer is an identifier (note: Identifier), written in full or relative to the source (note: Source) of the API note; a note (note: Note) listed under the ## Consumers section (note: Section) of the API note is declared too; a note cites the API when a serves link (note: Link) between the two was read in that note, the API's own consumers attribute (note: Attribute) and ## Consumers section being declarations (17 passages, no note) rather than citations (note: Mention). The attribute asks for the reconciliation: an API note without it is left to the API without consumer check (note: Check).

Check W-API-CONSUMER-MISMATCH, severity (note: Severity) warning by default, documented with a before and after example in the check pages. The severity can be overridden per project (note: Project) or per repository (note: Knowledge repository).

Applies to

Properties4

Domain
Quality
Status
valid
Severity
warning

4 declared keys. The rest of the file is free text.

On this page1

  1. Applies to
See the neighbourhood map6 pages6Neighbourhood mapConsumer mismatch

Neighbourhood map Consumer mismatch

Distance1 hop

Neighbourhood map. The list below carries the same information as the map.existing pageword without a note

22 neighbours in total, more than the map shows.

textual equivalent

Six neighbours at most, always named. Beyond that the map teaches nothing: the list takes over.