Improve documentation regarding supported output formats #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## development #28 +/- ##
=============================================
Coverage 100.00% 100.00%
=============================================
Files 4 4
Lines 110 122 +12
=============================================
+ Hits 110 122 +12
Help us with your feedback. Take ten seconds to tell us how you rate us. |
This was already included as a comment, but makes more sense to include in the docstring. Especially as it is the intention to make the content of this constant more visible to end-users.
This information was already included as a comment. However, this information makes sense to surface to end-users as well. Especially given that it ties in to the `SUPPORTED_TEXT_PLAIN_SHOW_MIME_TYPES` configuration variable.
Although this information is also available on Kroki's website, it's convenient to have the information as it is encoded in this library readily available through Julia's help system.
…`text/plain` MIME types Ths `LIMITED_DIAGRAM_SUPPORT` lists all the known `text/plain` MIME types and links them to the diagram types that support that form of rendering. `SUPPORTED_TEXT_PLAIN_SHOW_MIME_TYPES` only lists the MIME types themselves.
…ypes in the docstring This makes the information more readily available through Julia's help system, instead of requiring people to look up the variable.
This declutters the main `runtests` file a bit and makes it easier to test only this particular piece of functionality (and to ignore it while testing other pieces of the package).
This declutters the main `runtests` file a bit and makes it easier to test only this particular piece of functionality (and to ignore it while testing other pieces of the package).
Instead of simply reusing the symbols used to track the different types of diagrams, it is nicer if the documentation refers to the different diagram types by their actual names. The intention is to use this information elsewhere as well.
This metadata has more uses than just supporting the docstrings of the string literals, e.g. in the `LIMITED_DIAGRAM_SUPPORT` table. Therefore it makes sense to put it in a more centralized location and formalize retrieval of the metadata more.
This uses friendlier names if they're available and ensures links to documentation are easily accessible.
The information in this table is mostly a mirror of the information available on Kroki's website, and the docstring of `LIMITED_DIAGRAM_SUPPORT`. Having this information visible directly on the landing page of the documentation provides a convenient reference for anyone skimming the documentation.
This makes adding caveats, e.g. with regards to supported output formats, easier by having one central location to document them before referring to Kroki's website.
bauglir
force-pushed
the
improve-diagram-output-format-support-docstrings
branch
from
4d1da91 to
c92dd03
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
All this information is available either through docstrings and phrased differently, or through Kroki's website. Aggregating all the information in Julia's help system should make the package a bit easier to work with.