[
https://issues.apache.org/jira/browse/CLIMATE-479?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14040381#comment-14040381
]
ASF GitHub Bot commented on CLIMATE-479:
----------------------------------------
GitHub user MJJoyce opened a pull request:
https://github.com/apache/climate/pull/81
CLIMATE-479 - Clean up return type documentation
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/MJJoyce/climate return-type-cleanup
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/climate/pull/81.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #81
----
commit c7e49f8f4a9b0bd1ebb98abd17c95ac20b98b110
Author: Michael Joyce <[email protected]>
Date: 2014-06-22T23:06:46Z
Update dataset_processor function parameter documentation
- Update the dataset_processor function documentation so the references to
ocw.dataset.Dataset objects are in a consistent form. In the future,
these should be updated to properly reference the Dataset object's
documentation (if possible).
commit fc6dde333416976f906d8a448534565bd60cc052
Author: Michael Joyce <[email protected]>
Date: 2014-06-22T23:29:46Z
Update data_source.local function parameter documentation
- Update the data_source.local function documentation so the references to
ocw.dataset.Dataset objects are in a consistent form. In the future,
these should be updated to properly reference the Dataset object's
documentation (if possible).
commit c26e8c518fcad5cd63ce0cb8805245b800913180
Author: Michael Joyce <[email protected]>
Date: 2014-06-22T23:32:47Z
Update data_source.rcmed function parameter documentation
- Update the data_source.rcmed function documentation so the references to
ocw.dataset.Dataset objects are in a consistent form. In the future,
these should be updated to properly reference the Dataset object's
documentation (if possible).
commit 9fb56bc198a9030580cd278eae498266b22fa9b0
Author: Michael Joyce <[email protected]>
Date: 2014-06-22T23:44:05Z
Update metrics function parameter documentation
- Update the metrics function documentation so the references to
ocw.dataset.Dataset objects are in a consistent form. In the future,
these should be updated to properly reference the Dataset object's
documentation (if possible).
- Minor documentation changes for clarity.
commit 77347e75d449fb9ae57bd49697999b2be8d5fe7f
Author: Michael Joyce <[email protected]>
Date: 2014-06-23T00:02:58Z
Update utils function parameter documentation
- Update the utils function documentation so the references to
ocw.dataset.Dataset objects are in a consistent form. In the future,
these should be updated to properly reference the Dataset object's
documentation (if possible).
- Minor documentation changes and rewordings for clarity.
----
> Clean up return type documentation in toolkit
> ---------------------------------------------
>
> Key: CLIMATE-479
> URL: https://issues.apache.org/jira/browse/CLIMATE-479
> Project: Apache Open Climate Workbench
> Issue Type: Improvement
> Components: documentation, general
> Affects Versions: 0.3-incubating
> Reporter: Michael Joyce
> Assignee: Michael Joyce
> Fix For: 0.4
>
>
> A number of the return types are documented inconsistently when they're
> returning the same thing. For instance, ocw.dataset.Dataset will be
> documented as any number of thinks (Dataset, Open Climate Dataset,
> ocw.Dataset, etc.). It would be nice to consolidate these.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
