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

(Re)Documenting catchfilebetweentags method of building latex files with Agda #5440

Closed
JacquesCarette opened this issue Jun 10, 2021 · 1 comment · Fixed by #5445
Closed
Labels
backend: latex LaTeX generation backend ux: documentation Issues relating to Agda's documentation
Milestone

Comments

@JacquesCarette
Copy link
Contributor

There are two methods to do this, the one that used to be documented using catchfilebetweentags, and one using \newcommand.

The documentation only mentions the latter now, while it used to only mention the earlier. This change was done by @nad in 38c0322 but there is no rationale given for why one method is preferred.

I suggest that both options be documented, and users left to choose. [If this is agreeable, I can do it.]

@nad
Copy link
Contributor

nad commented Jun 11, 2021

I don't see a problem with including both methods, if they have different use cases. Is the point of the method that uses catchfilebetweentags that the Agda code does not need to be in a LaTeX file? The currently documented method can be used inside a single .lagda.tex file if you want to present code in an order that does not match the order imposed by Agda.

@andreasabel andreasabel added this to the 2.6.3 milestone Aug 17, 2021
@andreasabel andreasabel added backend: latex LaTeX generation backend ux: documentation Issues relating to Agda's documentation labels Aug 17, 2021
@andreasabel andreasabel modified the milestones: 2.6.3, 2.6.2.1 Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend: latex LaTeX generation backend ux: documentation Issues relating to Agda's documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants