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

Docs: shorter dataset/datamodule/model names #571

Merged
merged 1 commit into from
Jun 15, 2022
Merged

Conversation

adamjstewart
Copy link
Collaborator

@adamjstewart adamjstewart commented Jun 12, 2022

Closes #569

Before

Cluttered, can't easily count the number of datasets:

Screen Shot 2022-06-11 at 9 24 29 PM

After

Simple, easy to find the dataset you're looking for:

Screen Shot 2022-06-11 at 9 24 42 PM

@adamjstewart adamjstewart added this to the 0.3.0 milestone Jun 12, 2022
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 12, 2022
@calebrob6
Copy link
Member

calebrob6 commented Jun 15, 2022

My only complaint here is that we lose what all the acronyms are supposed to mean in some cases, e.g. ADVANCE:

image

@calebrob6
Copy link
Member

(this isn't a big problem or anything and I agree the list is much more clean)

@adamjstewart
Copy link
Collaborator Author

Yes, we can put those acronyms in the package class docstring. I'll do that here.

@calebrob6 calebrob6 merged commit b412f52 into main Jun 15, 2022
@calebrob6 calebrob6 deleted the docs/shorter branch June 15, 2022 21:00
@adamjstewart adamjstewart mentioned this pull request Jul 11, 2022
yichiac pushed a commit to yichiac/torchgeo that referenced this pull request Apr 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Shorter dataset names in docs
2 participants