Clean up the code and add features #75
Conversation
Complete test cases and add formatting for author and status.
…ndex spacing error. Increase efficiency of replace_special.py
Add unittest for DLMF preprocessing
Add support for LaTeX comments in math_mode.py.
…ve_symbol functions in MathematicaToLaTeX
… preferred braces
| @@ -13,7 +13,97 @@ NOTE: The KLSadd.tex file only deals with chapters 9 and 14, as stated in the do | |||
|
|
|||
There was a problem hiding this comment.
Capitalize "python;" change "The updateChapters.py program" to just "updateChapters.py;" change "pdf" to ".PDF."
KLSadd_insertion/README.md
Outdated
| _______________________________________________________________________________ | ||
|
|
||
|
|
||
| First: the files |
There was a problem hiding this comment.
Change to a header; that is,
The Files
KLSadd_insertion/README.md
Outdated
| @@ -13,7 +13,97 @@ NOTE: The KLSadd.tex file only deals with chapters 9 and 14, as stated in the do | |||
|
|
|||
| NOTE: when you run updateChapters.py or linetest.py you need the KLSadd.tex file, tempchap9.tex, and tempchap14.tex in order to run the program. The program *generates* updated9.tex and updated14.tex files. | |||
There was a problem hiding this comment.
Why is generates italicized?
KLSadd_insertion/README.md
Outdated
|
|
||
| First: the files | ||
|
|
||
| - KLSadd.tex: This is the addendum we are working with. It has sections that correspond with sections in the chapter files, and it contains paragraphs that must be *inserted* into the chapter files. CAN BE FOUND ONINE IN PDF FORM: https://staff.fnwi.uva.nl/t.h.koornwinder/art/informal/KLSadd.pdf |
There was a problem hiding this comment.
As aforementioned with generated, inserted.
KLSadd_insertion/README.md
Outdated
|
|
||
| - KLSadd.tex: This is the addendum we are working with. It has sections that correspond with sections in the chapter files, and it contains paragraphs that must be *inserted* into the chapter files. CAN BE FOUND ONINE IN PDF FORM: https://staff.fnwi.uva.nl/t.h.koornwinder/art/informal/KLSadd.pdf | ||
|
|
||
| - chap09.tex and chap14.tex: these are chapter files. These are LaTeX documents that are chapters in a book. This is a book written by smart math people. But they did some things wrong, so another math person wants to fix them. That math person wrote an addendum file called KLSadd.tex and our job is to pull paragraphs out of KLSadd and insert them at the end of the relevant section in the chapter files. Every chapter is made up of sections and every section has subsections |
There was a problem hiding this comment.
The last sentence has no period
KLSadd_insertion/README.md
Outdated
|
|
||
| - newtempchap09.tex and newtempchap14.tex these are output files of linetest.py and this is what a standard output looks like. They are no longer up to date for updateChapters as it sorts by subsection, but still serve as good reference | ||
|
|
||
| Next: the specifications |
There was a problem hiding this comment.
This should also be a header, and perhaps the Python file names should be sub-headers.
KLSadd_insertion/README.md
Outdated
| Toward the end of every section in the chapter file, there is a subsection called "References". It basically just contains a bunch of references to sources and other papers. This is where unsorted materials go For example: | ||
| **These aren't real sections, obviously, just an example** | ||
|
|
||
| in chap09.tex: |
KLSadd_insertion/README.md
Outdated
| Each section has subsections like "Hypergeometric Representation", sections in KLSadd with "Hypergeometric Representation" should be seorted there. | ||
|
|
||
| Toward the end of every section in the chapter file, there is a subsection called "References". It basically just contains a bunch of references to sources and other papers. This is where unsorted materials go For example: | ||
| **These aren't real sections, obviously, just an example** |
There was a problem hiding this comment.
This line is awkward and clunky.
KLSadd_insertion/README.md
Outdated
|
|
||
| The variables: | ||
|
|
||
| These are the variables in the beginning |
There was a problem hiding this comment.
Not a full sentence, no period
Add link to the DRMF project.
|
@edward-bian in the future, if there's something in a pull request review that has been requested that you don't feel is necessary, please comment on it to say why it is unnecessary. I'm looking through my old review and there are a few things outstanding, which are unexplained as of now. |
|
@edward-bian why is it failing a unit test? Either the test or the code is wrong, and it definitely isn't ready to merge if it's failing a unit test |
There was a problem hiding this comment.
A bunch of these are the same issues that were there in the old review. Almost all of them are really quick fixes - do those first if you want. In addition, worry about fixing the unit tests first.
There are some things in here that may seem like I'm asking you to change some things without reason. In the end, if you think that something should not be changed, it is your call. However, if you decide to do this on a commented change, please reply to the comment mentioning why you chose to not make the change.
KLSadd_insertion/README.md
Outdated
| ``` | ||
| python updateChapters.py | ||
| Python updateChapters.py |
There was a problem hiding this comment.
This Python still should not be capitalized.
KLSadd_insertion/src/linetest.py
Outdated
| @@ -1,13 +1,7 @@ | |||
| __author__ = "Rahul Shah" | |||
| __status__ = "Development" | |||
|
|
|||
There was a problem hiding this comment.
Why were these lines removed? It seems that at least the __author__ line should be there instead of the same thing in the docstring comment
KLSadd_insertion/src/linetest.py
Outdated
|
|
||
| entireFile = file.readlines() | ||
| for word in entireFile: | ||
| index+=1 |
There was a problem hiding this comment.
Conventions - put spaces (index += 1)
There was a problem hiding this comment.
also @edward-bian generally please look through your code for instances of these kinds of comments where I may have missed it. I may not comment on each instance where there should be spaces but it should still be fixed.
KLSadd_insertion/src/linetest.py
Outdated
| @@ -17,151 +11,151 @@ | |||
| sections = [] | |||
| mathPeople = [] | |||
| newCommands = [] | |||
There was a problem hiding this comment.
Conventions - variable names should be underscore separated rather than camel cased
KLSadd_insertion/src/linetest.py
Outdated
| sec += i | ||
| sections.append(sec) | ||
|
|
||
| entireFile = file.readlines() |
There was a problem hiding this comment.
Why is tab length 8 spaces instead of 4?
| designator = "9." | ||
| elif chapticker2 == 1: | ||
| elif chapticker2 == 14: | ||
| designator = "14." |
There was a problem hiding this comment.
why not instead of doing the comparison, do designator = str(chapticker2) + "."
Also why is it called chapticker2 instead of just chapticker
| :param paragraphs_to_be_added: List containing additions to be added. | ||
| :param kls: The addendum that contains sections to be added (not processed). | ||
| :param kls_list_all: List of all identified keywords, fed into the chapter sorter. | ||
| :param chapticker2: Which chapter is being searched (9 or 14). |
There was a problem hiding this comment.
why is it chapticker2 and not chapticker as it was before? also this should be spaced with underscores.
As above
| # get the index | ||
| startindex = 9999 | ||
| for word in addendum: | ||
| index += 1 |
| if "subsub" in word and index > startindex-1: | ||
| klsaddparas.append(index - 1) | ||
| if "\subsection*{" in word and index > startindex-1: | ||
| klsaddparas.append(index - 1) |
There was a problem hiding this comment.
three of these conditions are exactly the same
| if "14." in word: | ||
| chap_nums.append(14) | ||
| name = word[word.find("{") + 1: word.find("}")] | ||
| math_people.append(name + "#") |
There was a problem hiding this comment.
These conditions result in the same thing but the chap_nums part - the rest should not be in the if
Improve code quality and functionality of tex2wiki
physikerwelt
force-pushed
the
master
branch
3 times, most recently
from
75e720e to
9a65ba3
Compare
|
@edward-bian how much progress have you made |
|
It ended
…On Nov 3, 2017 1:19 PM, "Parth Oza" ***@***.***> wrote:
@edward-bian <https://github.com/edward-bian> how much progress have you
made
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#75 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/APrWvkFJ17ZarbYznAII5uMnfLJjj2cbks5sy0shgaJpZM4JiiYW>
.
|
|
@edward-bian How much progress have you made |
|
Progress report? |
Jagan, you're very funny. :) |
Cleaned up the code and improved existing functions