Giter Club home page Giter Club logo

Comments (2)

katyhuff avatar katyhuff commented on August 11, 2024

dotson.pdf

Lots of items from the writing checklist should be reviewed again.

  • Other misused/overused words include: code, input, output, different, value, amount, model.
  • clunky nouns -> spunky verbs (progression, expression --> progress, express)
  • reduce vague words (important, methodological)
  • get rid of extraneous prepositions (the meeting happened on monday -> the meeting happened monday) (they agreed that it was true -> they agreed it was true)
  • get rid of passive voice (is/was/are/were/be/been/am + past tense verb), replace with active voice
  • use strong verbs (use sparingly: is, are, was, were, be, been, am)
  • avoid turning verbs into nouns ("obtain estimates of" -> "estimates"; "provides a description of" -> "describes") (management of power systems -> power systems management, to the task of net load prediction -> to predict net load, the task of net load forecasting -> to forecast net load)
  • don't bury the verb (keep the predicate close to the subject at the beginning of the sentence)
  • Always use isotopic notation like $^{239}Pu$. Never $Pu-239$ or plutonium-239.
  • A phrase of the form ion of is probably clearer as ion. (For example, convert "calculation of velocity" to "velocity calculation".)
  • Cite all software. Review the principles and try CiteAs if necessary.
  • Refer to software consistently by name.

Additional Table and Figure Checklist:

  • When referring to figures by their number, use Figure 1 and Table 1. They should be capitalized and not abbreviated (not fig. 1 or figure 1.)

Additional Math Comments

  • define all variables, with units. If unitless, indicate that this is the case $[-]$.
  • Variables should be defined in the align environment as well, not buried in paragraphs.
    Here’s an example of an equation:
The line is defined as
\begin{align}
y&=mx + b
\intertext{where}
y&= \mbox{ height of the line, also known as rise [m]}\nonumber\\
m&= \mbox{ slope [-]}\nonumber\\
x&=\mbox{ independent parameter, known as run [m]}\nonumber\\
b&= \mbox{ y intercept [m].}
\end{align}

from pride.

katyhuff avatar katyhuff commented on August 11, 2024

I am going to close this issue (because my review is now complete). But, I'll open a new issue, assigned to you (@samgdotson), which can be closed with updates to the paper.

from pride.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.