The bulk of the changes here have to do with the stuff I described in #9.
These changes don’t add any new AtomDoc syntax — that'd have to go in pulsardoc. And they don't even change how things look about the docs (though there are some other small cosmetic changes in this PR). But they do allow for tooling to use the customData field to specify overrides for section names, method names, and method signatures.
The other major functional change is an extension to hovercard syntax — the ability to use custom link text. This is another thing we'll need for custom data overrides (since the original name still serves as the hovercard “slug”) — but it has other benefits that we can start enjoying.:
It's a good idea {::save "to save the document"} before calling this method.
The phrase “to save the document” will now be the link text, and you enjoy all the other benefits of the curly-brace syntax — the appearance of the hovercard, not needing to know the exact URL structure, et cetera.
The bulk of the changes here have to do with the stuff I described in #9.
These changes don’t add any new AtomDoc syntax — that'd have to go in pulsardoc. And they don't even change how things look about the docs (though there are some other small cosmetic changes in this PR). But they do allow for tooling to use the
customDatafield to specify overrides for section names, method names, and method signatures.The other major functional change is an extension to hovercard syntax — the ability to use custom link text. This is another thing we'll need for custom data overrides (since the original name still serves as the hovercard “slug”) — but it has other benefits that we can start enjoying.:
The phrase “to save the document” will now be the link text, and you enjoy all the other benefits of the curly-brace syntax — the appearance of the hovercard, not needing to know the exact URL structure, et cetera.