Skip to content

Use of RFC 2119 terms in documentation and comments #804

Closed
@jdsika

Description

@jdsika

Describe the problem

While I was reviewing PRs for v3.7.0 I stumbled across this description:

// Route segments that form the route of an agent.
//
// Consecutive segments should be connected without gaps, meaning that the
// two of them should form a continuous area.
//
repeated RouteSegment route_segment = 2;

Ask your question

SHALL we use or RECOMMEND the use of terms derived from The Dublin Core, RFC 2413.

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Metadata

Metadata

Assignees

Labels

DocumentationEverything which impacts the quality of the documentation and guidelines.SuggestionsI just want to drop by and leave this suggestion to think about.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions