Opened 2 years ago

Closed 2 years ago

#23539 closed defect (fixed)

Docstring formatting in refinement_graphs.pyx

Reported by: jmantysalo Owned by:
Priority: minor Milestone: sage-8.1
Component: documentation Keywords:
Cc: tscrim, chapoton Merged in:
Authors: Jori Mäntysalo Reviewers: Travis Scrimshaw, Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: 484fd6c (Commits) Commit: 484fd6cc4c5804bb47df1ce31ff1e8dea53e190f
Dependencies: Stopgaps:

Description (last modified by jmantysalo)

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

Patch contains no code changes.

Change History (17)

comment:1 Changed 2 years ago by jmantysalo

  • Branch set to u/jmantysalo/search_tree-docstring

comment:2 Changed 2 years ago by jmantysalo

  • Cc tscrim chapoton added
  • Commit set to f3c7126b8ebf1cbfdc88128cdec40a0a574d344e
  • Description modified (diff)
  • Status changed from new to needs_review

New commits:

f3c7126Docstring formatting.

comment:3 follow-up: Changed 2 years ago by 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.).

comment:4 Changed 2 years ago by git

  • Commit changed from f3c7126b8ebf1cbfdc88128cdec40a0a574d344e to 2a6b09934c891ecffc5a7d7a5babd0a294a39df7

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

6153a7dMinor corrections.
2a6b099Wrong line on my develop-branch, a correction.

comment:5 in reply to: ↑ 3 Changed 2 years ago by jmantysalo

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.

comment:6 Changed 2 years ago by jmantysalo

A ping, maybe this one could be closed.

comment:7 Changed 2 years ago by tscrim

  • Reviewers set to Travis Scrimshaw
  • Status changed from needs_review to positive_review

Yes, sorry. LGTM. Thanks.

comment:8 follow-up: Changed 2 years ago by jdemeyer

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

  • src/doc/en/reference/groups/index.rst

    diff --git a/src/doc/en/reference/groups/index.rst b/src/doc/en/reference/groups/index.rst
    index 204c3cc..1d28cc2 100644
    a b Partition Refinement 
    8787
    8888   sage/groups/perm_gps/partn_ref/canonical_augmentation
    8989   sage/groups/perm_gps/partn_ref/data_structures
     90   sage/groups/perm_gps/partn_ref/refinement_graphs
    9091   sage/groups/perm_gps/partn_ref/refinement_lists
    9192   sage/groups/perm_gps/partn_ref/refinement_matrices
    9293

comment:9 Changed 2 years ago by git

  • Commit changed from 2a6b09934c891ecffc5a7d7a5babd0a294a39df7 to 4ec61151f38d6fa7e6d9ed173669c5b03837cf65
  • Status changed from positive_review to needs_review

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

a7ccf66Docstring formatting.
c2d2729Minor corrections.
4ec6115Wrong line on my develop-branch, a correction.

comment:10 in reply to: ↑ 8 Changed 2 years ago by jmantysalo

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.

comment:11 follow-up: Changed 2 years ago by jdemeyer

You need 8.1.beta8 for that.

comment:12 Changed 2 years ago by git

  • Commit changed from 4ec61151f38d6fa7e6d9ed173669c5b03837cf65 to c71331bad1df1980a73c855de3c736cdd4cc2890

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

933d469Docstring formatting.
8f27fb4Minor corrections.
c71331bWrong line on my develop-branch, a correction.

comment:13 Changed 2 years ago by git

  • Commit changed from c71331bad1df1980a73c855de3c736cdd4cc2890 to 484fd6cc4c5804bb47df1ce31ff1e8dea53e190f

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

484fd6cAdd to index.

comment:14 in reply to: ↑ 11 Changed 2 years ago by jmantysalo

Replying to jdemeyer:

You need 8.1.beta8 for that.

Ah, OK. This done.

comment:15 Changed 2 years ago by jdemeyer

Positive review if this passes patchbot testing.

comment:16 Changed 2 years ago by tscrim

  • Reviewers changed from Travis Scrimshaw to Travis Scrimshaw, Jeroen Demeyer
  • Status changed from needs_review to positive_review

Green bot (essentially).

comment:17 Changed 2 years ago by vbraun

  • Branch changed from u/jmantysalo/search_tree-docstring to 484fd6cc4c5804bb47df1ce31ff1e8dea53e190f
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.