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

Examples improvement: highlight with/without connectivity in unstructured examples #824

Open
trexfeathers opened this issue Jun 12, 2024 · 1 comment
Labels
type: documentation Auto-labelled for doc/* and docs/* branches

Comments

@trexfeathers
Copy link
Collaborator

📚 Documentation

Half the unstructured examples don't use the connectivity= parameter in Transform.from_unstructured(), while the other half do. Something different is clearly happening under the hood, but it is not obvious what (in fact I need to do some investigating before I understand it!). I think it would be good to highlight the difference within the relevant examples.

Happy to have a go at this if I can make the time.

@trexfeathers trexfeathers added new: documentation Highlight a new community raised "documentation" issue type: documentation Auto-labelled for doc/* and docs/* branches labels Jun 12, 2024
@bjlittle
Copy link
Owner

bjlittle commented Jun 12, 2024

My aim was to keep the gallery examples informative to showcase specific features, but simple i.e., not bloat the narrative with any deeper explanations.

Instead, there will be places in the geovista documentation where a fuller treatment and explanation of the how, what and why e.g., either through the tutorials, how-to guides or enrichment material.

Once the supporting documentation is available, then I think it would be ideal to link to the relevant material from the gallery examples.

Does that seem like a reasonable approach?

@bjlittle bjlittle removed the new: documentation Highlight a new community raised "documentation" issue label Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Auto-labelled for doc/* and docs/* branches
Projects
Status: 🆕 Candidate
Development

No branches or pull requests

2 participants