-
-
Notifications
You must be signed in to change notification settings - Fork 59
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
Define and document an API #77
Milestone
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Before the release of 1.0, there must be a clear demarcation of what is or is not part of the API. This is especially needed for other packages which have latexify as a dependency and which use the
@latexrecipe
macro. SemVer is useless if nothing is considered part of the API and it is crippling if the API includes everything.Clearly part of the API:
latexify
latexify
for all different kinds of input types or combinations thereof.latexify
.env=:align
gives a latex align environment, ect. The general form of the output string.Less clear:
A few spaces here or there or whether something is surrounded by
\mathrm{}
should not matter too much for users. Having this exact string be a part of the API means that every little enhancement to the output would be a breaking change and requires a major version bump. This would slow down such enhancements greatly. However, not having in the API makes testing very difficult which is a problem for anyone relying on a@latexrecipe
.The text was updated successfully, but these errors were encountered: