Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Documentation for Polycyclic Groups #17399

Merged
merged 7 commits into from Aug 18, 2019

Conversation

@divyanshu132
Copy link
Member

commented Aug 13, 2019

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
@sympy-bot

This comment has been minimized.

Copy link

commented Aug 13, 2019

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:

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.

<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234". See
https://github.com/blog/1506-closing-issues-via-pull-requests . Please also
write a comment on that issue linking back to this pull request once it is
open. -->


#### Brief description of what is fixed or changed
Added documentation describing all the functionalities of polycyclic groups in detail.

#### Other comments


#### Release Notes

<!-- Write the release notes for this release below. See
https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more information
on how to write release notes. The bot will check your release notes
automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
*  combinatorics
   * added documentation for polycyclic groups
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

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 ---|

This comment has been minimized.

Copy link
@jksuom

jksuom Aug 13, 2019

Member

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

>>> 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]

This comment has been minimized.

Copy link
@jksuom

jksuom Aug 16, 2019

Member

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

This comment has been minimized.

Copy link
@divyanshu132

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.

This comment has been minimized.

Copy link
@jksuom

jksuom Aug 16, 2019

Member

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

This comment has been minimized.

Copy link
@divyanshu132

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
@codecov

This comment has been minimized.

Copy link

commented Aug 16, 2019

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
* `v = {x_{i+1}}^{a_j}{x_i}^{-1}`
* `v = {x_i}^{a_j}`

`a_j \notin \{0, \ldots relative\_order[j]-1\}`.

This comment has been minimized.

Copy link
@jksuom

jksuom Aug 17, 2019

Member

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

This comment has been minimized.

Copy link
@divyanshu132

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.

This comment has been minimized.

Copy link
@jksuom

jksuom Aug 18, 2019

Member

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

This comment has been minimized.

Copy link
@divyanshu132

divyanshu132 Aug 18, 2019

Author Member

Yes, font is same for both.

@jksuom jksuom merged commit 75d3e3f into sympy:master Aug 18, 2019

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

@divyanshu132 divyanshu132 deleted the divyanshu132:polycyclic-group-docs branch Aug 18, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.