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

Check writing style / format / content 👔 #4

Closed
61 of 74 tasks
KarelZe opened this issue Oct 7, 2022 · 2 comments · Fixed by #427
Closed
61 of 74 tasks

Check writing style / format / content 👔 #4

KarelZe opened this issue Oct 7, 2022 · 2 comments · Fixed by #427
Assignees
Labels
writing Everything related to the document

Comments

@KarelZe
Copy link
Owner

KarelZe commented Oct 7, 2022

Check for the following mistakes:

  • Cref, units, spaces between units (\SI{10}{\percent}), plot ranges, supress titles, [H]. See this guide
  • Is everything rounded to the right precision?
  • Are page numbers correct?
  • Make sure toc is not so much fragmented / chapters have an equal length (feeback from @CaroGrau)
  • Does the text follow the Gopen rules?
  • Does the text contain inconsistent capitalization?
  • Does the text contain overly long sentences?
  • Does the text contain deeply nested sentences?
  • Check for tense
  • Check for inconsistent decimal point
  • Check for inappropriate adjectives
  • Check for correct citations
  • Is the notation in formulas consistent?
  • Is the notation in formulas complete?
  • Is the economic intuition always clear?
  • Check if document is printable in copyshop
  • Check your spelling and grammar e. g., with Grammarly
  • Check academic grammer with this tool
  • Check grammar with MS office
  • Check for active voice
  • Within your text, two headlines must not be next to each other, instead, add a separating sentence that introduces the topic.
  • paper should have an outline.
  • paper should have an abstract. (The abstract should be placed before the table of contents.)
  • Formulae are followed by a punctuation, e.g. 2+2 = 4.
  • Check the number of number of decimal places. A number such as 1.23456 might be correct, but given possible
    perturbations and errors of the original data, it is common to restrict oneself to roughly one to three decimal places
    (e.g. 1.23). This is done by rounding correctly. This does not affect your original R output; copy this “as it is”.
  • Explain all the variables (especially in formulae) you use.
  • Variables must be in italic, such as 𝑥𝑥 instead of x.
  • Do not put a colon “:” in the line before formulae.
  • athematical explanations are not clear/comprehensible.
  • Longer equations should be placed in a separate line – either aligned to the left or centered.
  • The usage of variable names is not coherent. This issue results e.g. from using some variable 𝑒𝑒 as an error term and then as a time series.
  • Replace “×” in formulae by “∙” as this is more common. See .\check_formalia.py.
  • Check if some of your figures have a low resolution or appear pixelated.
  • Check your captions beneath figures. Correct examples are: Fig. 1. Some text. Figure 2. Some other text.
    Pay attention that the text starts with a capital letter and the sentence is accompanied by a punctuation.
  • Check if figures/tables are not referenced in the text.
  • When referencing figures and tables in the text, it is more common to use a capital letter such as “Equation (3)”, “Figure 1” and “Table 2”. See .\check_formalia.py.
  • The first line of your table (the one with the column names) should always be printed in bold.
  • Do some non-trivial definitions/explanations need a reference?
  • When citing websites, add the date when accessed.
  • When adding books in your bibliography, add publisher and location of publishing.
  • When citing from textbooks, please also include the page numbers in the reference.
  • Are the references in the text are in a correct format?
  • Kindly fix the capitalization in your bibliography in order to make it consistent.
  • Check you if your introduction lacks a good, coherent motivation.
  • Add a summarizing sentence in your conclusion that tells which model, after all, you recommend.
  • Add examples where noted.
  • Check if you need to add further evaluations?
  • Check if your explanations are not clear/comprehensible.
  • Check if the usage of capitalization in your headlines is inconsistent. Either use ALWAYS capital initial letters such as in “Table of Contents” or ALWAYS an initial capital letter followed by small ones such as “Table of contents”.
  • Before brackets, there must be a space. Not, “ordinary least squares(OLS)”, but “ordinary least squares (OLS)”.
  • Check with numbers or sentence punctuations (point, comma, etc.) for incorrect spacing.
    In most cases, a footnote at the end of a sentence follows the punctuation as this example shows.
  • Check if spacing after paragraphs is consistent
  • Check if language is biased
  • Check if paragraphs are created consistently
  • Check for consistency between paragraphs
  • Check if hyphenization is correct in babel
  • Check if graphics are consistent to the "Ten Simple Rules for Better Figures"
  • Check citation counts with zotero addon
  • Check validity of doi with zotero plugin / fetch valid dois
  • Check all links in thesis, if they can be resolved via script
  • Check if words appear with and w/o hyphen
  • Check if all abbrevations in the text are wrapped in gls{}
  • Check if there are unnecessary abbrevations. Done automatically with Add chapter on Lee and Ready algorithm + proofreading 🔢 #154.
  • Make sure terms from supervised ml are used consistently. See e. g., here.
  • Set up consistent plotting early on e. g. style. E. g., see SciencePlots.
  • Run LaTeX cleaner from here.
  • Make pdf archivable see here. or here.
  • Check this guide for visualizations and use HSL color space.
  • Polish up the most important plots and findings for use in paper
  • Do final check with writeful
  • Run biber for incomplete entries. See comment of @lxndrblz in Edit in annotations from review🎒 #173.
  • Check if I included some American words 🇺‍🇸 https://codewordsolver.com/american-british-english-translator/ or auto-convert with python https://github.com/orsinium-labs/eng/tree/master/eng
  • Run biber --validate_datamodel thesis.bcf
  • Check if links refer to the correct labels. Are there duplicate labels?
@KarelZe KarelZe added this to the Thesis milestone Oct 7, 2022
@KarelZe KarelZe self-assigned this Oct 7, 2022
@KarelZe KarelZe changed the title Check writing style Check writing style / format / content Oct 7, 2022
@KarelZe KarelZe mentioned this issue Oct 16, 2022
5 tasks
KarelZe added a commit that referenced this issue Oct 22, 2022
- finds and outputs broken links
- Addresses #4
KarelZe added a commit that referenced this issue Oct 22, 2022
- hyphenated vs. contigous word
- inconsistent use of multiplier
- acronyms not wrapped in gls

Adresses #4
@KarelZe KarelZe changed the title Check writing style / format / content Check writing style / format / content 👔 Oct 25, 2022
@KarelZe KarelZe added the writing Everything related to the document label Nov 6, 2022
@KarelZe
Copy link
Owner Author

KarelZe commented Jun 25, 2023

Do some more improvements today.

@KarelZe
Copy link
Owner Author

KarelZe commented Jun 26, 2023

Work on it once discussion is done. Otherwise things might change to often.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
writing Everything related to the document
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant