Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation for Public symbols #26

Open
dishmint opened this issue Feb 25, 2023 · 1 comment
Open

Update Documentation for Public symbols #26

dishmint opened this issue Feb 25, 2023 · 1 comment
Assignees
Labels
docs Improvements or additions to documentation

Comments

@dishmint
Copy link
Owner

dishmint commented Feb 25, 2023

Make sure all exposed symbols are reflected in the documentation.

@dishmint dishmint self-assigned this Feb 25, 2023
@dishmint
Copy link
Owner Author

dishmint commented Mar 2, 2023

ImportMarkdown::usage = "ImportMarkdown[s] imports string s into symbolic markdown\nImportMarkdown[f] imports file f into symbolic markdown"
LineRules::usage = "LineRules[f] gives the line tokenization rules for Markdown flavor f"
LinkRules::usage = "LinkRules[f] gives the link tokenization rules for Markdown flavor f"
BlockRules::usage = "BlockRules[f] gives the block tokenization rules for Markdown flavor f"
DelimiterRules::usage = "DelimiterRules[f] gives the delimiter tokenization rules for Markdown flavor f"
MarkdownRules::usage = "MarkdownRules[f] gives the tokenization rules for Markdown flavor f"
MarkdownDelimiters::usage = "MarkdownDelimiters[f] gives the delimiters for Markdown flavor f"
MarkdownLexer::usage = "MarkdownLexer[s,r] lexes the string s with rules r\nMarkdownLexer[ls, r] lexes the list of strings ls with rules r"
MarkdownToken::usage = "Represents a lexed Markdown token"
MarkdownParser::usage = "MarkdownParser[tk,r] parses the token tk into symbolic markdown via the rules r\nMarkdownParser[tks, r] parses the list of tokens tks into symbolic markdown via the rules r"
MarkdownElement::usage = "Represents a symbolic Markdown element"

@dishmint dishmint added this to the Publish WLMarkdown Paclet milestone Mar 4, 2023
@dishmint dishmint added the docs Improvements or additions to documentation label Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant