Opened 7 years ago

Closed 7 years ago

#17887 closed enhancement (fixed)

SingularKernelFunction documentation is too touchy

Reported by: Snark Owned by:
Priority: minor Milestone: sage-6.6
Component: documentation Keywords:
Cc: Merged in:
Authors: Julien Puydt Reviewers: Martin Albrecht
Report Upstream: N/A Work issues:
Branch: 0f7ffaf (Commits, GitHub, GitLab) Commit: 0f7ffafd02a763ab7ca7a3ce5a50de0eef1ceff1
Dependencies: Stopgaps:

Status badges


This is different from ticket #17872 (where doc is actually broken) : here my debian experiments show that some parts of sage can break a little too easily.

The singular functions are created using code in src/sage/libs/singular/function.pyx, while their documentation comes from src/sage/interfaces/ : singular.hlp is scanned and documentation nodes get added. So if by chance you create a singular function in sage under the name say "NF" but the documentation has it under the name "reduce", one might get a working function with an exception-rising help because the node doesn't correspond.

I'll propose a patch to replace this with a little error message.

Change History (4)

comment:1 Changed 7 years ago by Snark

  • Branch set to u/Snark/singularkernelfunction_documentation_is_too_touchy

comment:2 Changed 7 years ago by Snark

  • Commit set to 0f7ffafd02a763ab7ca7a3ce5a50de0eef1ceff1
  • Status changed from new to needs_review

New commits:

0f7ffafDisplay an error message instead of triggering an exception in documentation of singular functions

comment:3 Changed 7 years ago by malb

  • Reviewers set to Martin Albrecht
  • Status changed from needs_review to positive_review

This looks good to me.

comment:4 Changed 7 years ago by vbraun

  • Branch changed from u/Snark/singularkernelfunction_documentation_is_too_touchy to 0f7ffafd02a763ab7ca7a3ce5a50de0eef1ceff1
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.