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.

Sign up for GitHub

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

Jump to bottom

Write intro chapter for documentation / tests for all functionalities #25

Open
dbosk opened this issue Nov 28, 2016 · 4 comments
Open

Write intro chapter for documentation / tests for all functionalities #25

dbosk opened this issue Nov 28, 2016 · 4 comments
Milestone
v2.0

Comments

@dbosk
Copy link
Owner

dbosk commented Nov 28, 2016 •
edited
Loading

The chapter should decribe how to use the makefiles. A good way is to literally
document the Makefile used in the repo. This Makefile uses a lot of the
available functionality. Thus it can also serve as "tests" for the functionalities.
@dbosk dbosk modified the milestone: v2.0 Mar 2, 2017
@dbosk
Copy link
Owner Author

dbosk commented Mar 12, 2017

The makefile for texgen is a good example for tex.mk, noweb.mk and package.mk.

@dbosk
Copy link
Owner Author

dbosk commented Apr 28, 2018

The intro chapter should test all functionality, thus we can merge #3 with this issue.

@dbosk dbosk mentioned this issue Apr 28, 2018
Closed
@dbosk dbosk changed the title Write intro chapter for documentation Write intro chapter for documentation / tests for all functionalities Dec 11, 2019
dbosk added a commit that referenced this issue Jan 11, 2020
@dbosk
Updates structure for tests.mk (#25)
e8250f3 
We now introduce `tests.mk` in the intro chapter. However, the tests
will be covered in each chapter (i.e. in the NOWEB file of each
include).

There is a `tests.nw` file which sets up the structure. This file is
covered in the introduction. However, each file, e.g. `tex.mk.nw`, will
also have a code block `<<tests.mk>>` containing all test code. Then
`tests.mk` can be constructed from `tests.nw tex.mk.nw` and so on.

The rationale is that the tests should be with the code. Otherwise they
risk getting out of sync.
@dbosk
Copy link
Owner Author

dbosk commented Jan 11, 2020

The intro chapter now documents the repo Makefile. This illustrates some use, but not all.

@dbosk
Copy link
Owner Author

dbosk commented Jan 20, 2022

This is related to #69.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.0
Development

No branches or pull requests
1 participant
@dbosk