fix for https://github.com/pvlib/pvlib-python/issues/102

[dacoex]

inserted link to variables

[wholmgren]

Thanks. Perhaps I wasn't clear enough in #102... Since you seem particularly interested in improving the documentation, I recommend that you set up readthedocs.org to render your fork of pvlib. This will make it easier to review this PR and future PRs. If you're just making small edits to the docs then I don't think it's needed, but here it will be helpful to see the rendered version since you're making new files and tables.

It is pretty simple to make an account on readthedocs, hook it up to your github account, and then tell rtd to render your fork and possibly your doc_var branch. See here:

http://docs.readthedocs.org/en/latest/getting_started.html#import-your-docs

Then post a comment here with a link to your version of the new docs.

[dacoex]

See this:
http://pvlib-python-dacoex.readthedocs.org/en/latest/

[wholmgren]

Thanks, that is helpful. A few comments:

1. The page name is "Variables and style rules" but it currently only has a table of variables. We need to either just have the table of variables and change the name or we need to include some text about style rules and keep the name as is. I don't have an opinion on what's best.
2. I'd replace "rules" with "conventions".
3. Do we need to keep the "comments" column? I'd say no.
4. Do we want to keep the wiki page after merging this? I'd say delete it so that we don't have to make these changes in two places.

[dacoex]

OK. 1 question to my earlier comment 👍

Additionally, the csv values can be reused, e.g. to assign variables or translate variables into >descriptions.

We could add the table to the folder
https://github.com/pvlib/pvlib-python/tree/master/pvlib/data

Then, we could read the variables in and make descriptive lables for graphs etc from it:

long_name = variable_csv_file['dni']

[wholmgren]

We could add the table to the folder
https://github.com/pvlib/pvlib-python/tree/master/pvlib/data Then, we could read the variables in and make descriptive lables for graphs etc from it: long_name = variable_csv_file['dni']

Maybe. I doubt that many people would take advantage of something like that, but it probably doesn't hurt anything. We'd probably want to change the multiple-valued cells if we did this.

[dacoex]

@wholmgren I will move the table
https://github.com/pvlib/pvlib-python/tree/master/pvlib/data

this makes renaming to the agreed variables easier.

[wholmgren]

@dacoex you should rebase this and rebuild your docs now that #108 has been merged.

[wholmgren]

No need to change this.

[wholmgren]

@dacoex thanks for the updates. Please see the line notes above.

[dacoex]

all proposals where I did not add a counter comment above are noew implemented.

Probably left with the table wrap issue.

[wholmgren]

multiple typos in this line

[wholmgren]

I prefer transposition_factor to tf.

[wholmgren]

Doesn't look like it's rendering right now.

http://pvlib-python-dacoex.readthedocs.org/en/latest/variables_style_rules.html

[dacoex]

looks good now, I hope. CU tomorrow. I am in another tz (UTC+1)

[wholmgren]

Looks good, thanks.

[dacoex]

Thanks for the patience. I can only learn from this peer review. And it increases my confidence in the code.

Next time tell me and I will stash the trial and error together.