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

Feature/add spatialid md #26

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

buscandoaverroes
Copy link
Contributor

  • add explanatory guide (/documentation/Guide01.ipynb
  • add spatial_id introductory markdown

@buscandoaverroes buscandoaverroes added the documentation Improvements or additions to documentation label Jun 24, 2024
@buscandoaverroes buscandoaverroes linked an issue Jun 24, 2024 that may be closed by this pull request
Copy link
Member

@HarutakaMatsumoto HarutakaMatsumoto left a comment

Choose a reason for hiding this comment

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

I reviewed it.
Check it out.

@@ -1,2 +1,3 @@
**/.DS_Store
.vscode/**/*
**/log/**/*
Copy link
Member

Choose a reason for hiding this comment

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

GitHub is warning you because the last line is missing a newline.
This absence causes an incorrect comparison.
This is not your fault, but please add a newline.

"- FitClearanceAroundExtendedSpatialID()\n",
"\n",
"### External Data and License Notice\n",
"This guide will use geodetic coordinates from [OpenStreetMap](openstreetmap.org/copyright); please note that the data is available under the Open Database License. Please refer to the link for more information. The following code is not part of OpenStreeMap; it's provided by Trajectory under the MIT license. Please feel free to learn and contribute!\n",
Copy link
Member

Choose a reason for hiding this comment

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

First, the web link is incorrect and cannot be accessed.
Please fix it.

Second, OpenStreeMap is a typo.
Please fix it.

- `x` is the Longitude Index
- `y` is the Latitude Index
- `vZoom` is the Vertical Zoom Level
- `f` is the Altitude Index
Copy link
Member

Choose a reason for hiding this comment

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

This identifier is z.
Please correct it.
The same applies to the others.

Copy link
Member

Choose a reason for hiding this comment

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

Why do you use GoNB instead of Godoc?
This document requires us to install GoNB and Jupyter Notebook, and understand what %% means.
Is that cost less than the benefit of this document?

Copy link
Member

Choose a reason for hiding this comment

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

Why do you use markdown instead of Godoc?

@HarutakaMatsumoto
Copy link
Member

I rewrite this to GoDoc.

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.

Add explanation in README for new functions in PR#6
2 participants