Skip to content

Add logos and clarify some docstrings #688

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

Merged
merged 10 commits into from
Apr 11, 2019
Merged

Add logos and clarify some docstrings #688

merged 10 commits into from
Apr 11, 2019

Conversation

cwhanse
Copy link
Member

@cwhanse cwhanse commented Apr 10, 2019

pvlib python pull request guidelines

Thank you for your contribution to pvlib python! You may delete all of these instructions except for the list below.

You may submit a pull request with your code at any stage of completion.

The following items must be addressed before the code can be merged. Please don't hesitate to ask for help if you're unsure of how to accomplish any of the items below:

  • Closes issue Clarify clearsky.harwitz docstring #687
  • I am familiar with the contributing guidelines.
  • Fully tested. Added and/or modified tests to ensure correct behavior for all reasonable inputs. Tests (usually) must pass on the TravisCI and Appveyor testing services.
  • Updates entries to docs/sphinx/source/api.rst for API changes.
  • Adds description and name entries in the appropriate docs/sphinx/source/whatsnew file for all changes.
  • Code quality and style is sufficient. Passes LGTM and SticklerCI checks.
  • New code is fully documented. Includes sphinx/numpydoc compliant docstrings and comments in the code where necessary.
  • Pull request is nearly complete and ready for detailed review.

Copy link
Member

@mikofski mikofski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • check the markdown for the image on README, it needs a preceding exclamation mark if you want it to show the image, and not just link to the file.
  • also is there a way to view the rendered docs? do you have a separate read the docs account for pull requests?
    thanks!

README.md Outdated
@@ -1,4 +1,4 @@
pvlib-python
[pvlib-python](docs/sphinx/source/_images/pvlib_logo_horiz.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add preceding exclamation mark for image to render, see GitHub Markdown guide

![pvlib-python](docs/sphinx/source/_images/pvlib_logo_horiz.png)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Do you know how to specify a display size?

I can make a pre-release tag that will build on readthedocs. Otherwise I don't know how to view the change to index.rst

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can go into your readthedocs account and set up a new project that points to your fork. cwhanse-pvlib-python or something like that. Then you have to go into your new project's settings and turn on the build for your branch.

Alternatively, I can test locally if we're ready for that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set up a readthedocs for my fork, that is the long-term solution.

Copy link
Member Author

@cwhanse cwhanse Apr 10, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The index.rst file renders in the viewer here.

Ready for review.

@codecov
Copy link

codecov bot commented Apr 10, 2019

Codecov Report

Merging #688 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #688   +/-   ##
=======================================
  Coverage   92.57%   92.57%           
=======================================
  Files          52       52           
  Lines        7485     7485           
=======================================
  Hits         6929     6929           
  Misses        556      556
Impacted Files Coverage Δ
pvlib/irradiance.py 95.85% <ø> (ø) ⬆️
pvlib/clearsky.py 96.7% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e9d25c...6c6dec4. Read the comment docs.

Copy link
Member

@wholmgren wholmgren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Looks good to me.

Copy link
Member

@mikofski mikofski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks! I'll go ahead and respond to NumFOCUS

@wholmgren wholmgren merged commit b61e149 into pvlib:master Apr 11, 2019
@@ -1,5 +1,4 @@
pvlib-python
============
<img src="docs/sphinx/source/_images/pvlib_logo_horiz.png" width="600" height="260">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cwhanse sorry to reopen this, but I think you should remove the height="260" from the <img> tag because it's rendering weird in my phone.
image
If I remove the height="260" then it renders fine:
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note the Sphinx/Readthedocs html only uses width="600" and no height:
image
and renders fine on responsive devices:
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did check when I clicked approve, and it seemed fine then, so not sure what happend :(

@cwhanse
Copy link
Member Author

cwhanse commented Apr 11, 2019

thanks for the attention to detail @mikofski !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants