M2 icon indicating copy to clipboard operation
M2 copied to clipboard

Documentation for flattenRing doesn't fully describe functionality

Open kschwede opened this issue 8 years ago • 2 comments

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...)

kschwede avatar Jul 14 '17 02:07 kschwede

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

lilysilverstein avatar Jul 14 '18 22:07 lilysilverstein

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.

lilysilverstein avatar Jul 22 '18 16:07 lilysilverstein