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

Guide to using GeoJsonDataSource #2977

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

jDilshodbek
Copy link
Contributor

This guide was written on purpose of following GeoJson documentation

@louwers louwers added documentation Improvements or additions to documentation android labels Oct 28, 2024
Copy link
Collaborator

@louwers louwers left a comment

Choose a reason for hiding this comment

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

General comment: this guide, while providing useful information, also has some unnatural wording. Maybe you can use tools like ChatGPT to help out. For example: "A GeoJsonDataSource might be constructed with several approaches" is grammatically correct, but "There are several ways to construct a GeoJsonDataSource" is much better. https://chatgpt.com/share/671f749c-c8e4-8008-b35e-28277e63bc38 Be careful with ChatGPT because it can also generate long unnatural flowery sentences that are not to the point.

There are also quite some grammatical issues that I cannot all address in a review. https://www.grammarly.com/ is another tool you might want to try.

Google has a good technical writing course that you might find helpful. https://developers.google.com/tech-writing They have a section on active vs. passive voice. An active voice can help improve sentences like:

Probably the most advanced use case might be animating random objects such as cars.

You also have a lot of paragraphs that are a single sentence, which is uncommon. Again, the course has some advice on writing good paragraphs.

@jDilshodbek
Copy link
Contributor Author

reformatted and refined grammatically and logically with ChatGPT.

- Loading from local files

with assets folder file
```kotlin
Copy link
Collaborator

@louwers louwers Nov 2, 2024

Choose a reason for hiding this comment

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

All code snippets (except really small ones) should be referenced so that we can be sure they compile in the future.

Copy link
Collaborator

@louwers louwers left a comment

Choose a reason for hiding this comment

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

Better, but there are still some issues.

Also I would like to get #2978 merged before accepting new documentation content, as everything we merge now needs to be ported over to the new site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
android documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants