Skip to content

finalize whatsnew v0.6.0 #575

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 6 commits into from
Sep 17, 2018
Merged

finalize whatsnew v0.6.0 #575

merged 6 commits into from
Sep 17, 2018

Conversation

wholmgren
Copy link
Member

See here for rendered whatsnew documentation: https://wholmgren-pvlib-python-new.readthedocs.io/en/latest/whatsnew.html

I will make the 0.6.0 tag as soon as this is merged.

@wholmgren wholmgren added this to the 0.6.0 milestone Sep 12, 2018
@wholmgren wholmgren requested a review from cwhanse September 12, 2018 16:26
@mikofski
Copy link
Member

nits: there are several texts in the what's new that should probably be formatted as code or linked using Sphinx markup

@mikofski
Copy link
Member

another nit: IMO we should be consistent in tag names, always using v prefix for versions, even in what's new, eg: "v0.7", not just "0.7"

@mikofski
Copy link
Member

mikofski commented Sep 12, 2018

sorry, I would like to do more, but here's the start of a patch (use git apply <patch-file>), there's still more ...

--- a/whatsnew_0600.rst
+++ b/whatsnew_0600.rst
@@ -17,31 +17,31 @@
   that can calculate a quantity using multiple algorithms now start
   with the prefix ``get_``. For example, ``relativeairmass`` can calculate
   airmass using one of many ``model`` arguments. Its name has been changed
-  to ``get_relative_airmass``. The old function names remain in this
+  to :func:`~pvlib.atmosphere.get_relative_airmass`. The old function names remain in this
   release, but will emit a ``PVLibDeprecationWarning`` when called. The
-  old functions will be removed in the 0.7 release. Functions composed
+  old functions will be removed in the v0.7 release. Functions composed
   of multiple words jammed together have been renamed with underscores
   separating the words (see above).
   Each change is detailed below. (:issue:`427`)
-* Deprecated relativeairmass. relativeairmass will be removed in 0.7.
-  Use the new get_relative_airmass instead. (:issue:`427`)
-* Deprecated absoluteairmass. absoluteairmass will be removed in 0.7.
-  Use the new get_absolute_airmass instead. (:issue:`427`)
-* Deprecated irradiance.globalinplane. globalinplane will be removed in 0.7.
-  Use the new irradiance.poa_components instead. (:issue:`427`)
-* Added irradiance.poa_components. Function is the same as the now-deprecated
-  irradiance.globalinplane, but adds 'poa_sky_diffuse' and
-  'poa_ground_diffuse' to the output. (:issue:`427`)
-* Deprecated irradiance.extraradiation. Use irradiance.get_extra_radiation
-  instead. irradiance.extraradiation will be removed in 0.7. (:issue:`427`)
-* Deprecated irradiance.grounddiffuse. Use irradiance.get_ground_diffuse
-  instead. irradiance.grounddiffuse will be removed in 0.7. (:issue:`427`)
-* Added irradiance.get_poa_sky_diffuse. (:issue:`427`)
-* Deprecated irradiance.total_irrad. Use irradiance.get_total_poa_irradiance
-  instead. irradiance.total_irrad will be removed in 0.7. (:issue:`427`)
-* Removed 'klutcher' from get_sky_diffuse/total_irrad. This misspelling was
+* Deprecated ``relativeairmass``; it will be removed in v0.7.
+  Use the new :func:`~pvlib.atmosphere.get_relative_airmass` instead. (:issue:`427`)
+* Deprecated ``absoluteairmass``; it will be removed in v0.7.
+  Use the new :func:`~pvlib.atmosphere.get_absolute_airmass` instead. (:issue:`427`)
+* Deprecated ``irradiance.globalinplane``; it will be removed in v0.7.
+  Use the new :func:`~pvlib.irradiance.poa_components` instead. (:issue:`427`)
+* Added :func:`~pvlib.irradiance.poa_components`. Function is the same as the now-deprecated
+  ``irradiance.globalinplane``, but adds ``'poa_sky_diffuse'`` and
+  ``'poa_ground_diffuse'`` to the output. (:issue:`427`)
+* Deprecated ``irradiance.extraradiation``; it will be removed in v0.7.
+  Use :func:`pvlib.irradiance.get_extra_radiation` instead. (:issue:`427`)
+* Deprecated ``irradiance.grounddiffuse``; it will be removed in v0.7. Use
+  :func:`~pvlib.irradiance.get_ground_diffuse` instead. (:issue:`427`)
+* Added :func:`~pvlib.irradiance.get_poa_sky_diffuse`. (:issue:`427`)
+* Deprecated ``irradiance.total_irrad``; it will be removed in v0.7. Use
+  :func:`~pvlib.irradiance.get_total_poa_irradiance` instead. (:issue:`427`)
+* Removed ``'klutcher'`` from ``get_sky_diffuse``/``total_irrad``. This misspelling was
   deprecated long ago but never removed. (:issue:`97`)
-* pvsystem.calcparams_desoto now requires arguments for each module model
+* :func:`~pvlib.pvsystem.calcparams_desoto` now requires arguments for each module model
   parameter. (:issue:`462`)
 * Add losses_parameters attribute to PVSystem objects and remove the kwargs
   support from PVSystem.pvwatts_losses. Enables custom losses specification

@mikofski
Copy link
Member

@wholmgren you also added codecov ci too, maybe add that to the end of the Testing section after SticklerCI ?

@wholmgren
Copy link
Member Author

@mikofski thanks! can you make a pull request to my fork?

@wholmgren
Copy link
Member Author

there are several texts in the what's new that should probably be formatted as code or linked using Sphinx markup

this is more work than I've usually cared to put into it. For reference, pandas is good about formatting names as something other than regular text, but does not always link to the function.

@cwhanse
Copy link
Member

cwhanse commented Sep 12, 2018

@mikofski thanks for showing how the markup can be done. I haven't gotten very far figuring this out, I try to imitate what others have submitted.

@wholmgren
Copy link
Member Author

wholmgren commented Sep 12, 2018

We should make the contributors list in the release notes be consistent with all of ways that we say that people can contribute to pvlib in our documentation:

https://pvlib-python.readthedocs.io/en/latest/contributing.html

So, I went through many of the closed issues/pull requests tagged with 0.6.0 to find who created the issue or commented on it. I've added the following people to the 0.6.0 contributors list:

@adriesse @cedricleroy @thunderfish24 @jforbess @jdnewmil @josricha @anomam @grisaitis @kdebrab @tadatoshi

Here's the new rendered list: https://wholmgren-pvlib-python-new.readthedocs.io/en/latest/whatsnew.html#contributors

I apologize if I missed anyone -- if so please comment now! We can also amend this version's notes after it's released.

Thanks @adriesse for catching this.

@markcampanelli
Copy link
Contributor

You all have done a ton of work for this release. Nice! I hope I can catch up at some point.

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.

hooray!

@cwhanse cwhanse merged commit 15c00ef into pvlib:master Sep 17, 2018
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.

4 participants