Docstring formatting in refinement_graphs.pyx

[f29946bc-ee7b-48cd-9abc-3445948c551d]

See for example search_tree? after from sage.groups.perm_gps.partn_ref.refinement_graphs import search_tree.

Patch contains no code changes.

CC: @tscrim @fchapoton

Component: documentation

Author: Jori Mäntysalo

Branch/Commit: 484fd6c

Reviewer: Travis Scrimshaw, Jeroen Demeyer

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

[f29946bc-ee7b-48cd-9abc-3445948c551d]

Branch: u/jmantysalo/search_tree-docstring

[f29946bc-ee7b-48cd-9abc-3445948c551d]

New commits:

f3c7126

Docstring formatting.

[f29946bc-ee7b-48cd-9abc-3445948c551d]

Commit: f3c7126

[f29946bc-ee7b-48cd-9abc-3445948c551d]

Description changed:

--- 
+++ 
@@ -1 +1,4 @@
 See for example `search_tree?` after `from sage.groups.perm_gps.partn_ref.refinement_graphs import search_tree`.
+
+Patch contains no code changes.
+

[tscrim]

comment:3

It would be good if you also brought the documentation up to standards (some things need to be code formatted, removing periods in INPUT's, etc.).

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from f3c7126 to 2a6b099

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

6153a7d	Minor corrections.
2a6b099	Wrong line on my develop-branch, a correction.

[f29946bc-ee7b-48cd-9abc-3445948c551d]

comment:5

Replying to @tscrim:

It would be good if you also brought the documentation up to standards (some things need to be code formatted, removing periods in INPUT's, etc.).

Something done. However, the most needed thing is documenting input variables... At least for now I can not do that.

[f29946bc-ee7b-48cd-9abc-3445948c551d]

comment:6

A ping, maybe this one could be closed.

[tscrim]

comment:7

Yes, sorry. LGTM. Thanks.

[tscrim]

Reviewer: Travis Scrimshaw

[jdemeyer]

comment:8

If you fix the documentation, could you add it to the reference manual too?

diff --git a/src/doc/en/reference/groups/index.rst b/src/doc/en/reference/groups/index.rst
index 204c3cc..1d28cc2 100644
--- a/src/doc/en/reference/groups/index.rst
+++ b/src/doc/en/reference/groups/index.rst
@@ -87,6 +87,7 @@ Partition Refinement

    sage/groups/perm_gps/partn_ref/canonical_augmentation
    sage/groups/perm_gps/partn_ref/data_structures
+   sage/groups/perm_gps/partn_ref/refinement_graphs
    sage/groups/perm_gps/partn_ref/refinement_lists
    sage/groups/perm_gps/partn_ref/refinement_matrices

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 2a6b099 to 4ec6115

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. This was a forced push. New commits:

a7ccf66	Docstring formatting.
c2d2729	Minor corrections.
4ec6115	Wrong line on my develop-branch, a correction.

[f29946bc-ee7b-48cd-9abc-3445948c551d]

comment:10

Replying to @jdemeyer:

If you fix the documentation, could you add it to the reference manual too?

I don't see line sage/groups/perm_gps/partn_ref/data_structures in src/doc/en/reference/groups/index.rst.

[jdemeyer]

comment:11

You need 8.1.beta8 for that.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 4ec6115 to c71331b

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

933d469	Docstring formatting.
8f27fb4	Minor corrections.
c71331b	Wrong line on my develop-branch, a correction.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

484fd6c

Add to index.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from c71331b to 484fd6c

[f29946bc-ee7b-48cd-9abc-3445948c551d]

comment:14

Replying to @jdemeyer:

You need 8.1.beta8 for that.

Ah, OK. This done.

[jdemeyer]

comment:15

Positive review if this passes patchbot testing.

[tscrim]

comment:16

Green bot (essentially).

[tscrim]

Changed reviewer from Travis Scrimshaw to Travis Scrimshaw, Jeroen Demeyer

[vbraun]

Changed branch from u/jmantysalo/search_tree-docstring to 484fd6c