Skip to content
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

Update Documentation for cos_solar_zenith_angle Function #3276

Merged
merged 4 commits into from
Mar 12, 2024

Conversation

Sweetdevil144
Copy link
Contributor

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

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@meetagrawal09
Copy link
Collaborator

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

auto-merge was automatically disabled March 12, 2024 05:15

Head branch was pushed to by a user without write access

@mdietze mdietze added this pull request to the merge queue Mar 12, 2024
Merged via the queue into PecanProject:develop with commit 13afa6c Mar 12, 2024
13 checks passed
@infotroph infotroph mentioned this pull request Sep 26, 2024
13 tasks
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.

Broken link and missing documentation for cos_solar_zenith_angle()
4 participants