PecanProject / pecan

The Predictive Ecosystem Analyzer (PEcAn) is an integrated ecological bioinformatics toolbox.
www.pecanproject.org
Other
199 stars 230 forks source link

Update Documentation for cos_solar_zenith_angle Function #3276

Closed Sweetdevil144 closed 3 months ago

Sweetdevil144 commented 3 months ago

Description

Updated the documentation for the cos_solar_zenith_angle function in the PEcAn.data.atmosphere package. The update includes detailed descriptions of function parameters, clarification of the dt and hr parameters, addition of usage examples, and an updated reference link.

Motivation and Context

This update provides clarity and useful information to users, enhancing the usability of the function. Fixes #3084

Review Time Estimate

Types of changes

Checklist:

meetagrawal09 commented 3 months ago

I think you still have to run roxygen2::roxygenise over the package to update the Rd files based on the changes you made.

cc @infotroph, @mdietze