-
-
Notifications
You must be signed in to change notification settings - Fork 481
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
Improve documentation of m4/sage_spkg_configure.m4 #29018
Comments
comment:1
See also #26668 |
comment:2
I noticed this too but hadn't gotten around to it. I think now that a few people have a feel for how this works, we should rewrite the comment in sage_spkg_configure.m4. What's there is dubious, for example:
What first two arguments? Is PACKAGE-NAME included in that?
This "next" depends on me knowing what the first two arguments are that it's talking about, and I don't.
Last? Did we get all five? And why does the paragraph about the last argument then segue into a bullet list discussing all-but-one of them? In short, I think we should drop the exposition from the top, and start with the bullet list, from... The macro takes five arguments:
and then the discussion about those arguments should come after we know what they are. In particular the arguments can then be mentioned by name and position, so the reader knows exactly which argument we're talking about. |
comment:3
It should be checked whether #28788 added sufficient documentation. |
Dependencies: #28788 |
comment:4
pushing these forward to 9.2 |
comment:6
Setting new milestone based on a cursory review of ticket status, priority, and last modification date. |
This ticket improves the documentation of the m4 macros provided by
m4/sage_spkg_configure.m4
.Depends on #28788
CC: @dimpase @orlitzky
Component: documentation
Issue created by migration from https://trac.sagemath.org/ticket/29018
The text was updated successfully, but these errors were encountered: