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

[WIP] resample/warp tutorial #801

Open
wants to merge 2 commits into
base: as/cellarea_docs
Choose a base branch
from

Conversation

asinghvi17
Copy link
Collaborator

Adds a tutorial about resample/warp to the docs.

@asinghvi17 asinghvi17 changed the base branch from main to as/cellarea_docs October 13, 2024 14:07
@rafaqz
Copy link
Owner

rafaqz commented Oct 13, 2024

Again my question is if this should be in the API docs?

Better docs for all these methods are needed, but keeping maintenance efficient is really important long term!

I would really prefer to have one place to edit right near the functions, and tutorials for full workflows. Can we at least try that and only shift to this approach if it's obviously bad in some way?

@asinghvi17
Copy link
Collaborator Author

If the problem is having a place to edit near the function - should we switch to GeometryOps' literate style for Rasters as well? It would involve a bit of moving code around, giving each method its own file, etc. - but eventually you get all the benefits of long explanations and tutorials, and everything is also centralized.

@rafaqz
Copy link
Owner

rafaqz commented Oct 13, 2024

I'm happy for literate docs in GeometryOps.jl! I will learn them eventually. But I find the mental overhead of a translation layer a bit much. For example I haven't fixed basic Literate.jl docs issues at Interfaces.jl because I don't immediately understand the problem.

But my problem here is specifically having two places for all the main methods here rather than just one. I really want it to be just one docs thing per method. Both for maintenance, and I also worry that two will be confusing for users.

So we should stretch the current simple API docs to bursting point before having two places to look at the same thing in different ways.

I know it's kind of boring, but my job here is to push for improvements to the boring old things we already have, instead of new things :)

@asinghvi17
Copy link
Collaborator Author

It'd be very hard to understand a reference table of resample methods without pictures. So I'd argue that in this specific case, we do need a longer tutorial.

@asinghvi17
Copy link
Collaborator Author

But maybe this can go in geocompjl, and we can link to it...

@rafaqz
Copy link
Owner

rafaqz commented Oct 15, 2024

Can't you have pictures tho? The other methods do

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