Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents


Potential Solutions

...

By YAML Tag

We could use a custom YAML tag to achieve this. 

...

  • Construct
  • No space is allowed not to corrupt the document (check Further research part for more detail)

...

By File Name

We could indicate that YAML files are deprecated by simply adding deprecated in the file name as a prefix.

...

  • Can only deprecate the whole file, hence no possibility to deprecate sub-definitions of the definition
  • How to handle the name change of particular definition → system should do some resolution automatically which sounds nasty at the first place.

...

By YAML Property

Yet another idea would be to have default property for all definitions.

...

2) Use properties to describe since and description

...

With tag

We can still use !deprecated tag for marking the file as deprecated but the information of it will be stored in plain YAML properties like the following:

Code Pro
languageyaml
!deprecated
mgnl:deprecatedSince: 5.6
mgnl:deprecatedReason: Some reason

...

Without Tag

Or without the tag we could simply have it like:

...