Deprecate and remove hierarchy information from linkable-elements.json #1311
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable:
Summary
This deprecates and removes hierarchy information from the "linkable-elements.json" file.
This information isn't useful for the purpose of linking to these elements and isn't used anywhere when these elements are linked to.
It could be argued that this information provides a way for tools to read reconstruct the documentation hierarchy. However;
--enable-experimental-external-link-support
and use the information in "link-hierarchy.json" file instead.Dependencies
None
Testing
Pass the
--emit-digest
flag to DocC. The created "linkable-elements.json" file shouldn't contain any "taskGroups" information anymore.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
AddedUpdated tests./bin/test
script and it succeeded[ ] Updated documentation if necessary