-
Notifications
You must be signed in to change notification settings - Fork 54
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
Style and quality changes that need to be done #27
Comments
I've fixed all 10K or so style warnings I'm going to break this ticket up into smaller issues (the FIXME/TODO stuff is important; the variable case stuff can surely wait until we've got a release out). |
Good work. Really. I'm still working on that Inflections_Package (now mostly separating IO package bodies, making state more local, identifiers more self-documenting etc.). |
There's a block of massively duplicated code in Latin_Utils.Inflections_package.establish_inflections_section - it looks like a cut-n-paste of four copies of forty identical lines that differ by a single character (or something). Please factor that craziness into oblivion. |
@mk270 Chill, just found a way to factor it out nicely (a bit of a hack actually). They are not exactly 4 copies of same function - it is two copies of two functions differing by presence of one "exit when" statement. [and they further differ by character used in boolean expression inside that "exit when"] |
Thank you, that is excellent news :) |
I will list all style changes that need to be done for style changes to be completed:
all names (especially public ones) shall¹ use Ada naming convention [easy but tedious]²there shall spaces between binary operators and on left side of left parenthesis (unless it is preceded by apostrophe) [easy but tedious] ³there shall be no lines longer than 80 columnsAlso try to use FIXME, TODO and NOTE for (respectively) comments of bugs/problems, things that have to be done, description of non-obvious behavior, as they are easy to search for (with grep for example)
¹ used shall as 'should' is too permissive
² for interested: https://en.wikibooks.org/wiki/Ada_Style_Guide is commonly used quality and style guide for Ada, together with some examples and rationales behind style rules
The text was updated successfully, but these errors were encountered: