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
330 stars 228 forks source link

Documentation for flattenRing doesn't fully describe functionality #651

Open kschwede opened 6 years ago

kschwede commented 6 years ago

Sorry if this isn't the right place (ie, do Documentation Issues go here?), but the function flattenRing asserts:

write a ring as a (quotient) of a polynomial ring over ZZ or a prime field

However, as far I can tell, it also works for things over QQ, Galois fields, function fields, etc. The lower part of the documentation even seems to acknowledge this (ie, you can use toField...)

lilysilverstein commented 5 years ago

Indeed, several of the methods for flattenRing are currently undocumented. Will be fixed shortly.

lilysilverstein commented 5 years ago

Rewrote this documentation to include things like Galois fields and rings declared as fields.

I was extremely confused by the description of the Result option. I changed the page to go into much more detail, with more examples, of the various numbers, types, and sequences that can all be passed to Result. Finally, I added documentation nodes for the options.

Commit is here, and will be bundled into my next documentation pull request.