# Added Documentation for Polycyclic Groups #17399

Merged
merged 7 commits into from Aug 18, 2019

## Conversation

Member

### divyanshu132 commented Aug 13, 2019

#### Brief description of what is fixed or changed

Added documentation describing all the functionalities of polycyclic groups in detail.

#### Release Notes

• combinatorics
• added documentation for polycyclic groups
 polycyclic-group-docs 
 90aa827 

### sympy-bot commented Aug 13, 2019 • edited

 ✅ Hi, I am the SymPy bot (v147). I'm here to help you write a release notes entry. Please read the guide on how to write release notes. Your release notes are in good order. Here is what the release notes will look like: combinatorics added documentation for polycyclic groups (#17399 by @divyanshu132) This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.5. Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it. Click here to see the pull request description that was parsed.  #### Brief description of what is fixed or changed Added documentation describing all the functionalities of polycyclic groups in detail. #### Other comments #### Release Notes * combinatorics * added documentation for polycyclic groups  Update The release notes on the wiki have been updated.

### divyanshu132 added Documentation GSoC labels Aug 13, 2019

reviewed
 generators in pcgs say [x0, x1, x2, x3] and the relative_order vector is [2, 3, 2, 2]. Starting from bottom of this sequence the presentation is computed in order as below. >>> x3^2 ---|

#### jksuom Aug 13, 2019

Member

It looks like there are tabs. They should be removed. In addition, the comments should start with #.

 update 
 2b51a5e 
reviewed
 >>> x0^{-1}x3x0 |---> using [x3, x2, x1] from pcgs and pc_series[3] >>> x0^{-1}x2x0 | >>> x0^{-1}x1x0 ---| >>> x3^2 # ---|---> using only [x3] from pcgs and pc_series[4]

#### jksuom Aug 16, 2019

Member

It seems that >>> should not be included. Sphinx will try to run the code.

#### divyanshu132 Aug 16, 2019

Author Member

Okay, If we'll write it directly then, how we can use comments because I tried it without >>> but it generates an error due to the comments(basically due to|-->), or may be we can write those comments directly without using special symbols.

#### jksuom Aug 16, 2019

Member

Maybe it is | that is causing the problems. # will probably not be needed if this is not run.

#### divyanshu132 Aug 16, 2019

Author Member

It doesn't look good without >>> and keeping the above structure so, I tried removing those symbols and putting the comments up, have a look at the last commit, if it looks good.

 fix 
 ce39f45 
 fix-presentation-doc 
 04d5bfb 

# Codecov Report

Merging #17399 into master will decrease coverage by 0.042%.
The diff coverage is n/a.

@@              Coverage Diff              @@
##            master    #17399       +/-   ##
=============================================
- Coverage   74.697%   74.654%   -0.043%
=============================================
Files          631       632        +1
Lines       163266    163806      +540
Branches     38302     38429      +127
=============================================
+ Hits        121955    122289      +334
- Misses       35976     36162      +186
- Partials      5335      5355       +20
reviewed
 * v = {x_{i+1}}^{a_j}{x_i}^{-1} * v = {x_i}^{a_j} a_j \notin \{0, \ldots relative\_order[j]-1\}.

#### jksuom Aug 17, 2019

Member

This could probably be \text{relative\_order}[j].

#### divyanshu132 Aug 18, 2019

Author Member

In \text{relative\_order} \ before underscore is not working, it is printed as it is in html. So, I tried without any delimiter before underscore but that seems failing. I think we should try \mathrm.

#### jksuom Aug 18, 2019

Member

\mathrm should be ok if it works better. The font will probably be the same.

#### divyanshu132 Aug 18, 2019

Author Member

Yes, font is same for both.

 minor-update 
 a9673c6 
 update 
 45713a8 
 math-to-text 
 19d4814 

### jksuom merged commit 75d3e3f into sympy:master Aug 18, 2019 3 checks passed

#### 3 checks passed

codecov/project 74.654% (target 0%)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
sympy-bot/release-notes The release notes look OK
Details