Documenting is an important aspect of writing code, and thanks to DocC, it is easier than ever to create beautiful documentation from inline code comments and additional Markdown files.
Marco's guide for writing code documentation for Swift came in handy this week, as I was working on creating an interactive tutorial with DocC.
However, I noticed that some things work slightly differently for interactive tutorials. For example, callouts for tutorials have to start with
>, whereas you can use
- in source code docs.
This works fine for interactive tutorials:
> Warning: This will result in a compiler error.
- Warning: This will result in a compiler error.