Opened 7 years ago

Last modified 6 years ago

#16363 new enhancement

Explain category: autogenerated overview documentation of a category

Reported by: nthiery Owned by:
Priority: major Milestone: sage-6.4
Component: categories Keywords: days57
Cc: sage-combinat, hivert, SimonKing, darij, nbruin, pbruin, vbraun Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

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 #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

Change History (2)

comment:1 Changed 7 years ago by nthiery

  • Keywords days57 added

This was suggested by Volker at Sage Days 57

comment:2 Changed 6 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4
Note: See TracTickets for help on using tickets.