search

Macaulay2 / M2

The primary source code repository for Macaulay2, a system for computing in commutative algebra, algebraic geometry and related fields.
https://macaulay2.com
347 stars 231 forks source link

disallow the use of TEST in Macaulay2Doc #1712

Closed DanGrayson closed 3 years ago

DanGrayson commented 3 years ago

Is the use of TEST in Macaulay2Doc detected and an error message issued?

No. I don't think an error is worth it though.

I think it is, since if someone puts a test in and it doesn't get run, that's a bug. I'll make a new issue.

Originally posted by @DanGrayson in https://github.com/Macaulay2/M2/issues/1709#issuecomment-748206563

mahrud commented 3 years ago

Why wouldn't it get run? I think there could be tests specifically for the documentation; e.g. checking that there are no missing links, or things of that sort. That is, not Core tests, but actually Macaulay2Doc tests.

DanGrayson commented 3 years ago

Why wouldn't it get run?

Ah, I just assumed we stop checking Macaulay2Doc, once it had no tests. I guess not!

I think there could be tests specifically for the documentation; e.g. checking that there are no missing links, or things of that sort. That is, not Core tests, but actually Macaulay2Doc tests.

Okay, I'll close this issue.