Skip to content

Commit 96a6884

Browse files
committed
add api changes to whatsnew
1 parent 50da307 commit 96a6884

File tree

2 files changed

+39
-17
lines changed

2 files changed

+39
-17
lines changed

docs/sphinx/source/classes.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _classes:
2+
13
Classes
24
=======
35

@@ -51,3 +53,10 @@ SingleAxisTracker
5153
:undoc-members:
5254
:show-inheritance:
5355

56+
LocalizedSingleAxisTracker
57+
-----------------
58+
.. autoclass:: pvlib.tracking.LocalizedSingleAxisTracker
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+

docs/sphinx/source/whatsnew/v0.3.0.txt

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,44 @@ v0.3.0 (2016)
44
-----------------------
55

66
This is a major release from 0.2.2.
7+
It will almost certainly break your code, but it's worth it!
78
We recommend that all users upgrade to this version after testing
89
their code for compatibility and updating as necessary.
910

1011

11-
Enhancements
12-
~~~~~~~~~~~~
12+
API changes
13+
~~~~~~~~~~~
1314

14-
* Adds ``PVSystem``, ``LocalizedPVSystem``, ``ModelChain``,
15-
and ``SingleAxisTracker`` classes. (:issue:`17`)
16-
* Replaces ``location`` arguments with ``latitude``, ``longitude``,
15+
* The ``location`` argument in ``solarposition.get_solarposition``
16+
and ``clearsky.ineichen``
17+
has been replaced with ``latitude``, ``longitude``,
1718
``altitude``, and ``tz`` as appropriate.
1819
This separates the object-oriented API from the procedural API.
1920
(:issue:`17`)
20-
* ``Location`` classes can be created from TMY2/TMY3 metadata
21-
using the ``from_tmy`` constructor.
2221
* ``Location`` classes gain the ``get_solarposition``, ``get_clearsky``,
2322
and ``get_airmass`` functions.
24-
* Add Package Overview and Classes pages to documentation.
23+
* Adds ``ModelChain``, ``PVSystem``, ``LocalizedPVSystem``,
24+
``SingleAxisTracker``, and ``LocalizedSingleAxisTracker``
25+
classes. (:issue:`17`)
26+
* ``Location`` objects can be created from TMY2/TMY3 metadata
27+
using the ``from_tmy`` constructor.
28+
* Change default ``Location`` timezone to ``'UTC'``.
29+
* The solar position calculators now assume UTC time if the input time
30+
is not localized. The calculators previously tried to infer the timezone
31+
from the now defunct location argument.
32+
* ``pvsystem.sapm_celltemp`` argument names now follow the
33+
variable conventions.
34+
* ``irradiance.total_irrad`` now follows the variable conventions.
35+
(:issue:`105`)
36+
37+
38+
Enhancements
39+
~~~~~~~~~~~~
40+
41+
* Added new sections to the documentation:
42+
* :ref:`package_overview`
43+
* :ref:`variables_style_rules`
44+
* :ref:'classes`
2545
* Adds support for Appveyor, a Windows continuous integration service.
2646
(:issue:`111`)
2747
* The readthedocs documentation build now uses conda packages
@@ -38,20 +58,13 @@ Enhancements
3858
``atmosphere.TRUE_ZENITH_MODELS`` to enable code that can
3959
automatically determine which type of zenith data to use
4060
e.g. ``Location.get_airmass``.
41-
* Change default ``Location`` timezone to ``'UTC'``.
42-
* Added new sections to the documentation:
43-
* :ref:`package_overview`
44-
* :ref:`variables_style_rules`
61+
4562

4663
Bug fixes
4764
~~~~~~~~~
4865

49-
* ``pvsystem.sapm_celltemp`` argument names now follow the
50-
variable conventions.
51-
* ``irradiance.total_irrad`` now follows the variable conventions.
52-
(:issue:`105`)
5366
* Fixed the metadata key specification in documentation of the
54-
readtmy2 function.
67+
``readtmy2`` function.
5568
* Fixes the import of tkinter on Python 3 (:issue:`112`)
5669

5770

0 commit comments

Comments
 (0)