Skip to content

Align operator and property formatting for existing articles and tutorials #122

@banchan86

Description

@banchan86

The formatting of operators and properties is inconsistent across articles and tutorials. Standardizing the formatting will improve the clarity and polish while promoting best practices for future contributions to documentation.

Some examples

Articles

observables, subjects - The first operator reference uses xref, while subsequent operator references and properties use backticks for inline code formatting.
property mapping, higher-order operators - Most operator and property references use xref, but some do not.

Tutorials

acquisition - The first operator and property references use xref, with subsequent references using backticks.
close loop - Operators are formatted with xref, while properties use backticks (but it gradually disappears 😃 )

Proposed alignment

To align with the documentation style guide:

  • All operator references should use xref formatting.
  • All property references should use backticks for inline code formatting.

While applying this consistently may be more time-consuming than the other approaches, it eliminates the need to track previous mentions (for first reference formatting), reduces inconsistency, and clearly distinguishes operators from properties (avoiding an overuse of excessive highlighting).

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions