Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain category: autogenerated overview documentation of a category #16363

Open
nthiery opened this issue May 16, 2014 · 2 comments
Open

Explain category: autogenerated overview documentation of a category #16363

nthiery opened this issue May 16, 2014 · 2 comments

Comments

@nthiery
Copy link
Contributor

nthiery commented May 16, 2014

The purpose of this ticket is to complement the static documentation
of a category by an autogenerated overview of it including:

  • a description of the category taken from its docstring (if there is one)

  • the list of the important super categories (e.g. the result of
    super_structure_categories of Infrastructure for modelling full subcategories #16340)

  • the list of the axioms

  • the list of all the methods on parents, elements, ..., including the
    _test_*, _*_ and __**__ methods. For each method, there would
    be a short description (taken from the docstring), and information
    on where the method is defined (e.g. as an abstract method) and
    implemented.

  • ???

This feature would be particularly useful for categories with axioms
or functorial construction categories since in most case this would
provide complete information without having to write any static
documentation.

Possible user interface to access the documentation

  • Make it available with C?; this would require some magic to
    automagically replace the static documentation

  • Add an explain_category method

  • Use IPython's %pinfo/%pinfo2/help infrastructure

CC: @sagetrac-sage-combinat @hivert @simon-king-jena @darijgr @nbruin @pjbruin @vbraun

Component: categories

Keywords: days57

Issue created by migration from https://trac.sagemath.org/ticket/16363

@nthiery nthiery added this to the sage-6.3 milestone May 16, 2014
@nthiery
Copy link
Contributor Author

nthiery commented May 16, 2014

Changed keywords from none to days57

@nthiery
Copy link
Contributor Author

nthiery commented May 16, 2014

comment:1

This was suggested by Volker at Sage Days 57

@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.3, sage-6.4 Aug 10, 2014
@mkoeppe mkoeppe removed this from the sage-6.4 milestone Dec 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants