You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on May 2, 2020. It is now read-only.
Docile.jl currently relies on Markdown.jl during macro expansion time to parse docstrings into markdown ASTs. This adds to package load times and isn't really necessary since we can convert each docstring to a presentable format when calling writemime rather.
Splitting out the presentation code into a separate package (named, preliminarily, Lexicon.jl) will allow docstrings to be written in different markup, such as rst or asciidoc, once parsers are written.
A metadata field in Entry such as :format could specify what parser to use for each entry.
Storing the docstring as String rather that an AST also simplifies full text queries by not having to walk the AST; instead using contains directly.
Features that would move to Lexicon.jl include: query, @query, doctest, save, writemime.
Features that would be retained include: @doc, @docstrings, @tex_mstr.
The text was updated successfully, but these errors were encountered:
I've definitely found the package separation to be working out better.
Give me a shout if you encounter anything in either package that doesn't fit with your project, since I've not had the chance to try them out on anything very large yet.
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Docile.jl
currently relies onMarkdown.jl
during macro expansion time to parse docstrings into markdown ASTs. This adds to package load times and isn't really necessary since we can convert each docstring to a presentable format when callingwritemime
rather.Splitting out the presentation code into a separate package (named, preliminarily,
Lexicon.jl
) will allow docstrings to be written in different markup, such as rst or asciidoc, once parsers are written.A
metadata
field inEntry
such as:format
could specify what parser to use for each entry.Storing the docstring as
String
rather that an AST also simplifies full text queries by not having to walk the AST; instead usingcontains
directly.Features that would move to
Lexicon.jl
include:query
,@query
,doctest
,save
,writemime
.Features that would be retained include:
@doc
,@docstrings
,@tex_mstr
.The text was updated successfully, but these errors were encountered: