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

chore(docs): Update tile-converter.md #3084

Merged
merged 15 commits into from
Nov 5, 2024

Conversation

dsavinov-actionengine
Copy link
Collaborator

Typo and grammar minor fixes

Typo and grammar minor fixes
Co-authored-by: Viktor Belomestnov <belom88@yandex.ru>
added notes that 7z and slpk are deprecated now
| slpk | \* | | Whether the converter generates \*.slpk (Scene Layer Package) I3S output files |
| 7zExe | \* | | location of 7z.exe archiver to create slpk on Windows OS, default: "C:\\Program Files\\7-Zip\\7z.exe" |
| egm | \* | \* | location of the Earth Gravity Model (\*.pgm) file to convert heights from ellipsoidal to gravity-related format or "None" to not use it, default: "./deps/egm2008-5.pgm". A model file can be loaded from GeographicLib https://geographiclib.sourceforge.io/html/geoid.html |
| slpk | \* | | (Deprecated since version 4.3.0) <br> Whether the converter generates \*.slpk (Scene Layer Package) I3S output files. Note: For versions 4.3.0 and up \*.slpk is the default output wihtout this option specified. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| slpk | \* | | (Deprecated since version 4.3.0) <br> Whether the converter generates \*.slpk (Scene Layer Package) I3S output files. Note: For versions 4.3.0 and up \*.slpk is the default output wihtout this option specified. |
| slpk | \* | | (Deprecated since version 4.3.0) <br /> Whether the converter generates \*.slpk (Scene Layer Package) I3S output files. Note: For versions 4.3.0 and up the option doesn't work, \*.slpk is the only possible output of I3S. |

Copy link
Collaborator

Choose a reason for hiding this comment

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

The option --slpk is removed from npx tile-converter --help. we should add this information back

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Where should it be brought back? I mean where is the help text located? Can you send file path here?

Copy link
Collaborator

Choose a reason for hiding this comment

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

function printHelp(): void {

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Brought it back there.

| 7zExe | \* | | location of 7z.exe archiver to create slpk on Windows OS, default: "C:\\Program Files\\7-Zip\\7z.exe" |
| egm | \* | \* | location of the Earth Gravity Model (\*.pgm) file to convert heights from ellipsoidal to gravity-related format or "None" to not use it, default: "./deps/egm2008-5.pgm". A model file can be loaded from GeographicLib https://geographiclib.sourceforge.io/html/geoid.html |
| slpk | \* | | (Deprecated since version 4.3.0) <br> Whether the converter generates \*.slpk (Scene Layer Package) I3S output files. Note: For versions 4.3.0 and up \*.slpk is the default output wihtout this option specified. |
| 7zExe | \* | | (Deprecated since version 4.1.0) <br> location of 7z.exe archiver to create slpk on Windows OS, default: "C:\\Program Files\\7-Zip\\7z.exe". Note: For versions 4.1.0 and up 7z is not needed and tile-converter uses internal zip module instead. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

This option is removed. Remove it from the docs

Copy link
Collaborator Author

@dsavinov-actionengine dsavinov-actionengine Oct 30, 2024

Choose a reason for hiding this comment

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

Is it removed for 4.0.x and below? I thought maybe old versions need this option

Copy link
Collaborator

Choose a reason for hiding this comment

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

"Deprecated" means "You can use it, but it is not recommended". The options is removed and we cannot use it. May be "(Removed since version 4.1.0)" is better

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added as "(Removed since version 4.1.0)"

@dsavinov-actionengine dsavinov-actionengine merged commit b47fc68 into master Nov 5, 2024
2 checks passed
@dsavinov-actionengine dsavinov-actionengine deleted the dsavinov/tile-converter-docs branch November 5, 2024 11:32
belom88 pushed a commit that referenced this pull request Nov 5, 2024
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