Opened 2 years ago

Closed 2 years ago

#28679 closed defect (invalid)

Errors in the documentation of SetPartitions.

Reported by: pluschny Owned by:
Priority: minor Milestone: sage-duplicate/invalid/wontfix
Component: documentation Keywords:
Cc: Merged in:
Authors: Reviewers: Travis Scrimshaw
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

See http://doc.sagemath.org/html/en/reference/combinat/sage/combinat/set_partition.html

Two functions, shape() and shape_partition(), with identical descriptions and examples. But there seems to be no funtion shape_partition().

The function to_partition() has again the same examples as shape() and shape_partition() but does not show the use of to_partition().

Change History (5)

comment:1 Changed 2 years ago by mantepse

I think that this is intentional: see lines 875--877 of set_partition.py:

    # we define aliases for shape()
    shape_partition = shape
    to_partition = shape

comment:2 Changed 2 years ago by embray

  • Milestone changed from sage-9.0 to sage-9.1

Ticket retargeted after milestone closed

comment:3 follow-up: Changed 2 years ago by tscrim

  • Milestone changed from sage-9.1 to sage-duplicate/invalid/wontfix
  • Reviewers set to Travis Scrimshaw
  • Status changed from new to needs_review

This is a side affect of an alias.

comment:4 in reply to: ↑ 3 Changed 2 years ago by klee

  • Status changed from needs_review to positive_review

Replying to tscrim:

This is a side affect of an alias.

I respect the reviewer's decision. But for the future, we may consider adopting a documentation convention like

    #: alias of :meth:`shape`
    shape_partition = shape

    #: alias of :meth:`shape`
    to_partition = shape    

for aliases, to prevent confusion.

comment:5 Changed 2 years ago by chapoton

  • Resolution set to invalid
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.