#18107: The codes collection should describe how to import it as a real module
-------------------------------------+-------------------------------------
Reporter: jsrn | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-6.6
Component: coding theory | Resolution:
Keywords: sd66 | Merged in:
Authors: Johan S. R. | Reviewers: Nathann Cohen
Nielsen | Work issues:
Report Upstream: N/A | Commit:
Branch: | ad8a74f57121d8df1d40765330129a520f4f975f
u/jsrn/18107_coding_module | Stopgaps:
Dependencies: |
-------------------------------------+-------------------------------------
Old description:
> Currently, most coding theory-related stuff is hidden behind
> `codes.<tab>`. But it is done in a way which does not allow writing
>
> {{{
> from codes import *
> }}}
>
> whenever you're working a lot with coding theory.
>
> To allow this, `codes` should be a real module.
>
> To avoid having a real directory named `codes`, this module needs to be
> created at run-time. Thought should also be given to Shinx-generated
> documentation.
>
> A good solution could apply elsewhere: graphs, designs, etc.
New description:
Currently, most coding theory-related stuff is hidden behind
`codes.<tab>`. But it is done in a way which does not allow writing
{{{
from codes import *
}}}
whenever you're working a lot with coding theory.
Instead, one has to do
{{{
from sage.coding.codes_catalog import *
}}}
This could be mentioned in the doc of `codes`.
--
Comment (by jsrn):
I don't think I fully see why littering the global variable namespace is
fine, but littering the module namespace is bad.
But I also don't care enough about this to discuss it at length. I've
rolled back the changes and instead inserted a note in the doc of `codes`
on how to import it.
--
Ticket URL: <http://trac.sagemath.org/ticket/18107#comment:25>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
