Check docs for spelling and grammar

[jdebacker]

It's probably worth doing another run through the documentation for spelling and grammatical issues.

[duncanhobbs]

@jdebacker

I was looking though the ccc_gude.md file and fixing up a few small issues I saw. I had some questions about how things should look.

I notice that sometimes you have equations enclosed in $$ $$ and sometimes {math}

1) Is there a standard style that should be used?

2) It looks like the first labelled and numbered equation is computing measurements of fixed assets by industry and entity type. Are there other equations like the cost of capital, METR, METTER, or EATR that should be labelled in that section?

3) Should the equations that are on their own line always have commas at the end? I see some that do and some that do not.

[jdebacker]

@duncanhobbs Thanks for taking a look at this!

I notice that sometimes you have equations enclosed in $$ $$ and sometimes {math}

Is there a standard style that should be used?

{math} allows for equation labels, while $$ $$` does not. I think one could just use `{math}` throughout, but I kept the old markdown$$ $$` in many cases, just replacing it where labels were needed for references.

It looks like the first labelled and numbered equation is computing measurements of fixed assets by industry and entity type. Are there other equations like the cost of capital, METR, METTER, or EATR that should be labelled in that section?

Anything referenced in the text should be labeled. It's not necessary for any other equations, but it would be ok if they did have labels.

Should the equations that are on their own line always have commas at the end? I see some that do and some that do not.

If there's a continuation in the text (e.g., `y = a + bx, where a is the intercept and b is the slope) then there should be a comma after the equation.

[duncanhobbs]

Thanks.

Is there a way to build the documentation and ccc_guide locally so I can check how things look before submitting a PR?

I tried running

(ccc-dev) C:\Users\duncan.hobbs\Github\Cost-of-Capital-Calculator\docs\book> jupyter-book build content/

and got a message that a toc file could not be found.

[jdebacker]

@duncanhobbs asks:

Is there a way to build the documentation and ccc_guide locally so I can check how things look before submitting a PR?

Yes, from the /docs directory do: jb build ./book