Skip to content
This repository has been archived by the owner on May 2, 2020. It is now read-only.

Split package. #27

Closed
MichaelHatherly opened this issue Sep 12, 2014 · 2 comments
Closed

Split package. #27

MichaelHatherly opened this issue Sep 12, 2014 · 2 comments

Comments

@MichaelHatherly
Copy link
Owner

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.

@timholy
Copy link
Contributor

timholy commented Sep 23, 2014

This looks like a great change, thanks for being sensitive to this issue.

Just starting a new project, and I'm going to use Docile/Lexicon as I go.

@MichaelHatherly
Copy link
Owner Author

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 free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants