Fix printing guidelines #2769
Fix printing guidelines #2769
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2769 +/- ##
==========================================
+ Coverage 73.09% 73.10% +0.01%
==========================================
Files 450 450
Lines 64177 64177
==========================================
+ Hits 46909 46917 +8
+ Misses 17268 17260 -8 |
Properly explain how to reach each printing mode, and also explain what 'io' is
fingolfin
force-pushed
the
mh/fix-printing-docs
branch
from
839b063
to
e68e618
Compare
| @@ -173,7 +175,7 @@ end | |||
|
|
|||
| function Base.show(io::IO, b::B) | |||
| io = AbstractAlgebra.pretty(io) | |||
| print(io, LowercaseOff(), "Hilbert thing") | |||
| print(io, AbstractAlgebra.LowercaseOff(), "Hilbert thing") | |||
There was a problem hiding this comment.
I believe this is exported? Then AbstractAlgebra. is not necessary.
There was a problem hiding this comment.
As far as I understand, LowercaseOff, Indent, Dedent, pretty are imported from AbstractAlgebra into Oscar, thus one need not write AbstractAlgebra. in code inside Oscar; but they are not exported from Oscar.
There was a problem hiding this comment.
The example code uses an explicit AbstractAlgebra. everywhere else, and it should be consistent. With it there, a user can copy&paste the example code and start working with it, whether or not they have done using AbstractAlgebra (which is dangerous inside a package) or import AbstractAlgebra.
Anyway, my primary concern was to make it consistent. If someone prefers to drop the AbstractAlgebra. everywhere, that should be a seperate PR, IMHO
|
Looks good, once the the namespace has been figured out. |
Properly explain how to reach each printing mode, and also explain what 'io' is