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

Clean up the code and the documentation for the coding section #27634

Closed
kwankyu opened this issue Apr 10, 2019 · 57 comments
Closed

Clean up the code and the documentation for the coding section #27634

kwankyu opened this issue Apr 10, 2019 · 57 comments

Comments

@kwankyu
Copy link
Collaborator

kwankyu commented Apr 10, 2019

Lots of cleaning up of sage/coding folder:

  • reorganize the section on coding in the documentation

  • PEP8 fixes

  • 100% coverage for doctests

  • pyflakes fixes

  • rename bch.py to bch_code.py and grs.py to grs_code.py

  • cleanups for goppa.py

  • adding random_received_vector method to linear codes

and other small fixes.

CC: @johanrosenkilde

Component: coding theory

Author: Kwankyu Lee

Branch/Commit: 8b01cc5

Reviewer: Johan Rosenkilde

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

@kwankyu kwankyu added this to the sage-8.8 milestone Apr 10, 2019
@kwankyu
Copy link
Collaborator Author

kwankyu commented Apr 10, 2019

Branch: u/klee/27634

@kwankyu
Copy link
Collaborator Author

kwankyu commented Apr 10, 2019

Author: Kwankyu Lee

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 10, 2019

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

e0e2dd8Lots of code polishing

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 10, 2019

Commit: e0e2dd8

@kwankyu

This comment has been minimized.

@kwankyu kwankyu changed the title Refine coding code and documentation Refine the code and the documentation for sage/coding section Apr 10, 2019
@kwankyu kwankyu changed the title Refine the code and the documentation for sage/coding section Refine the code and the documentation for coding section Apr 10, 2019
@kwankyu

This comment has been minimized.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 11, 2019

Changed commit from e0e2dd8 to 8ca732d

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 11, 2019

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

8ca732dRemoved a deprecation notice

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 12, 2019

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

f06f23fFix a typo

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 12, 2019

Changed commit from 8ca732d to f06f23f

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 16, 2019

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

9707a5dMerge branch 'develop'

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 16, 2019

Changed commit from f06f23f to 9707a5d

@kwankyu

This comment has been minimized.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 28, 2019

Changed commit from 9707a5d to 4dbc2a8

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 28, 2019

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

1458655Merge branch 'develop' into codes-trac27634
4dbc2a8Merge branch 'develop' into codes-trac27634

@kwankyu kwankyu changed the title Refine the code and the documentation for coding section Clean up the code and the documentation for the coding section Jun 3, 2019
@kwankyu

This comment has been minimized.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 8, 2019

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

dbb26e8Clean up coding section

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 8, 2019

Changed commit from 4dbc2a8 to dbb26e8

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 11, 2019

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

ceb7dacMerge branch 'develop' into codes-1-trac27634

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 11, 2019

Changed commit from dbb26e8 to ceb7dac

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 25, 2019

Changed commit from ceb7dac to 8706828

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 25, 2019

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

a1eec5dMerge branch 'develop'
8706828Merge branch 'develop'

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 31, 2019

Changed branch from u/jsrn/27634 to public/27634

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 31, 2019

New commits:

fb35c2fFixes responding to reviewer comments
1bca13cMerge branch 'u/jsrn/27634'
6bf9f1eRemove unwanted names under codes
24df329A minor fix in the main document

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 31, 2019

Changed commit from 0b95c1d to 24df329

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 31, 2019

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

6c7012bA pyflakes fix in linear_code.py

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 31, 2019

Changed commit from 24df329 to 6c7012b

@johanrosenkilde
Copy link
Contributor

Reviewer: Johan Rosenkilde

@johanrosenkilde
Copy link
Contributor

comment:34

Great, thanks for reacting so fast! Let's get this into Sage :-) Positive review.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 31, 2019

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

c650b8aRename channel_constructions.py and goppa.py

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 31, 2019

Changed commit from 6c7012b to c650b8a

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 31, 2019

comment:36

Ah... I could not resist rushing these final changes to this ticket. Sorry.

I renamed "channel_constructions.py" to "channel.py" and "goppa.py" to "goppa_code.py". This seems to me more conforming to other file names.

I worry that you may object to the former change. If so, let me know.

@johanrosenkilde
Copy link
Contributor

comment:37

I'm OK with those changes, it's more conforming. Positive review.

@vbraun
Copy link
Member

vbraun commented Aug 2, 2019

comment:38

See patchbot:
{{{sage -t --long src/doc/en/thematic_tutorials/structures_in_coding_theory.rst # 2 doc
tests failed
}}}

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 3, 2019

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

8b01cc5Rename coding theory module names in thematic tutorials

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 3, 2019

Changed commit from c650b8a to 8b01cc5

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 3, 2019

comment:40

Doctest failures in thematic tutorials were fixed by simple string replacements for changed module names.

@vbraun
Copy link
Member

vbraun commented Aug 5, 2019

Changed branch from public/27634 to 8b01cc5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants