Skip to content

Commit

Permalink
Add notice on Metadata.UnidentifiedData in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBoxyBear authored Oct 29, 2024
1 parent f4e02cf commit e1c846e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Docs/articles/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Metadata metadata = Metadata.FromFiles(path1, path2, path3...);

When reading from multiple files, you can mix file types, and the priority of information is defined by the order of the files.

As a future-proofing method, all unsupported items can be found under [UnidentifiedData](~/api/ChartTools.Metadata.yml#ChartTools_Metadata_UnidentifiedData). This data will only be written to the same file format as the one it was read from.
As a future-proofing method, all unsupported items can be found under [UnidentifiedData](~/api/ChartTools.Metadata.yml#ChartTools_Metadata_UnidentifiedData). This data will only be written to the same file format as the one it was read from. This member should be used with caution, as keys which become mapped to properties in future versions of ChartTools will not appear in the set which would appear as the value being missing. [A new metadata mapping system is currently beign considered](https://github.com/TheBoxyBear/charttools/discussions/95)

### Instruments and Tracks
All instruments currently supported are represented using the generic [Instrument](~/api/ChartTools.Instrument.yml) class. This class contains an object of type [Track](~/api/ChartTools.Track.yml) class for every difficulty. A track can be retrieved from a song with the following code:
Expand Down Expand Up @@ -130,4 +130,4 @@ ChartFile.ReplaceInstrument("output.chart", guitar, <WritingConfiguration>);
```


Like when reading files, writing operations can be configured to alter how they deal with errors. [Learn more about configuring IO operations](configuration.md).
Like when reading files, writing operations can be configured to alter how they deal with errors. [Learn more about configuring IO operations](configuration.md).

0 comments on commit e1c846e

Please sign in to comment.