M2 icon indicating copy to clipboard operation
M2 copied to clipboard

documentation of named arguments

Open DanGrayson opened this issue 5 years ago • 1 comments

If "foo" is a method that accepts named arguments and is used in multiple packages, then we have no way for the documentation to depend on the package. If the named argument is called "Bar", then the documentation key is simply [foo,Bar], which gives no hint about the package, nor about the types of the arguments.

Maybe the documentation key could be something like [(foo,X),Bar], which would document what happens when foo is call with something of type X.

DanGrayson avatar Sep 29 '20 14:09 DanGrayson

On a similar note, citing documentation of symbols doesn't seem to work well across packages. The main instance I've run into is citing (symbol:, Ideal, Ideal), because Macaulay2Doc :: Ideal : Ideal doesn't work.

mahrud avatar Sep 30 '20 09:09 mahrud