korsbo/Latexify.jl

Increase test coverage.

Open

#27 opened on Jul 17, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Julia (590 stars) (59 forks)batch import
good first issuehelp wanted

Description

We really should be testing each and every feature of Latexify and currently we are not.

Test generation is made easy by a macro that we supply:

using Latexify
@Latexify.generate_test latexify("x/y")

generates a test and puts it in your clipboard to be pasted:

@test latexify("x/y") == 
raw"$\frac{x}{y}$"

One just have to make sure that the test does actually do what was expected. For markdown, one must also replace the raw with Markdown.MD and get the first newline right.

Contributor guide

Tech stack
None
Domain
testing
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Julia basicsLatexify package knowledgeTest macro usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Install Latexify.jl and use the @Latexify.generate test macro for each feature. Verify the generated test output matches expected LaTeX. For markdown, replace `raw` with `Markdown.MD` and adjust newline. Look at existing test files for style.
Increase test coverage. · korsbo/Latexify.jl#27 | Good First Issue