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

Setting up documentation pages #521

Merged
merged 4 commits into from
Nov 20, 2024
Merged

Setting up documentation pages #521

merged 4 commits into from
Nov 20, 2024

Conversation

danielmwatkins
Copy link
Contributor

I've added a placeholder logo and 3 pages where the main families of functions in the algorithm can be described.

Copy link
Member

@cpaniaguam cpaniaguam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Left two suggestions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool logo!


## Cloud masks
Setting thresholds for cloud mask

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this is a placeholder. Consider adding a TODO: <my task> which is easy to search for later.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is - there's an item for issue #522 for this

Comment on lines +81 to 82
## NOTE(dmw): For consistency, it would make sense to reverse the order of inputs to match landmask
function remove_landmask(landmask::BitMatrix, ice_mask::BitMatrix)::Array{Int64}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## NOTE(dmw): For consistency, it would make sense to reverse the order of inputs to match landmask
function remove_landmask(landmask::BitMatrix, ice_mask::BitMatrix)::Array{Int64}

Consider adding an issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good idea!

@danielmwatkins danielmwatkins merged commit 33e73d4 into main Nov 20, 2024
7 checks passed
@danielmwatkins danielmwatkins deleted the update_documentation branch November 20, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants