sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.38k stars 470 forks source link

Simplicial complexes: correct the documentation #27211

Closed jhpalmieri closed 5 years ago

jhpalmieri commented 5 years ago

The documentation for simplicial complexes is outdated: it should say that the vertex set is determined automatically from the facets (as their union).

Component: algebraic topology

Keywords: simplicial complex

Author: John Palmieri

Branch/Commit: 6ae1ee3

Reviewer: Darij Grinberg

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

jhpalmieri commented 5 years ago

Branch: u/jhpalmieri/simplicial-docs

jhpalmieri commented 5 years ago

Commit: 15ee788

jhpalmieri commented 5 years ago

New commits:

15ee788trac 27211: in a simplicial complex, the vertex set is determined
darijgr commented 5 years ago
comment:3
+   automatically: `V` is defined to be the union of the sets `K`. So

->

+   automatically: `V` is defined to be the union of the sets in `K`. So

===

+simplicial complex, specify its *facets*: the maximal subsets (with
+respect to inclusion) of the vertex set. Each facet can be specifed as

->

+simplicial complex, specify its *facets*: the maximal subsets (with
+respect to inclusion) of the vertex set that belong to `K`. Each facet can be specifed as

=== Other than this, LGTM if the doc compiles (I don't have Sage installed, so I can't check) and if your claim about maximal_faces being a number is true (is there a doctest?).

jhpalmieri commented 5 years ago
comment:4

Lines 980-981:

            sage: SimplicialComplex([2])
            Simplicial complex with vertex set (0, 1, 2) and facets {(0, 1, 2)}
darijgr commented 5 years ago
comment:5

Ah, perfect.

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 5 years ago

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

6ae1ee3trac 27211: in a simplicial complex, the vertex set is determined
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 5 years ago

Changed commit from 15ee788 to 6ae1ee3

jhpalmieri commented 5 years ago
comment:7

I made the other changes, too.

darijgr commented 5 years ago

Reviewer: Darij Grinberg

darijgr commented 5 years ago
comment:8

LGTM, thanks!

darijgr commented 5 years ago

Changed keywords from none to simplicial complex

vbraun commented 5 years ago

Changed branch from u/jhpalmieri/simplicial-docs to 6ae1ee3