error: documentation already provided for Local

[mikestillman]

Did this just recently start to be an error, rather than a warning?

I pulled from development earlier today (before the flurry of merged pull requests), and I get the following error now (which I thought was not an error very recently)?

The problem in any case seems to be that Local is on both the optionalNames, and optionalValues lists in Macaulay2Doc/options.m2. @DanGrayson Do you know which list it should be on, and how to get it to be only on that list?

 -- error: documentation already provided for Local
 -- ../../../../Macaulay2/packages/Macaulay2Doc/options.m2:36:0: ... here is the (end of the) new documentation
 -- ../../../../Macaulay2/packages/Macaulay2Doc/options.m2:32:0: ... here is the (end of the) previous documentation
 -- making example results for "localModulo"                                 -- 3.58961 seconds elapsed
 -- making example results for "hilbertSamuelFunction"                       -- 4.12731 seconds elapsed
 -- making example results for "isWellDefined(LocalRing)"                    -- 3.60986 seconds elapsed
 -- making example results for "liftUp"                                      -- 3.58521 seconds elapsed
 -- making example results for "localsyz"                                    -- 3.57108 seconds elapsed
 -- making example results for "localMingens"                                -- 3.57751 seconds elapsed
 -- making example results for "replacements for functions from version 1.0" -- 3.58714 seconds elapsed
 -- making example results for "localComplement"                             -- 3.57437 seconds elapsed
 -- making example results for "setMaxIdeal"                                 -- 3.60155 seconds elapsed
 -- making example results for "localResolution"                             -- 3.63465 seconds elapsed
 -- making example results for "LocalRings"                                  -- 3.55701 seconds elapsed
 -- making example results for "LocalRing"                                   -- 3.57438 seconds elapsed
 -- making example results for "localRing"                                   -- 3.5917 seconds elapsed
 -- making example results for "localPrune"                                  -- 3.57535 seconds elapsed
stdio:2:1:(3): error: 1 error(s) occurred in processing documentation for package LocalRings

[DanGrayson]

I'll look into it. I think it's always been an error to document something twice.

[DanGrayson]

Ask Mahrud about it -- it's his code from commit 77491f39cfd114b58fe93e0834c003a19d6d00ce .

@mahrud

[mahrud]

I'm happy to re-enable overriding existing documentation.

[DanGrayson]

I was wrong --- documenting something twice used to be just an error message. So Mahrud, your idea is a good one. But still, we shouldn't be documenting things twice -- if Local can be both an option name and an option value, its documentation should reflect that.