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

updated kaguyasp2isis docs to mention deprecation #3996

Merged
merged 5 commits into from
Sep 3, 2020
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions isis/src/kaguya/apps/kaguyasp2isis/kaguyasp2isis.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
<application name="kaguyasp2isis" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://isis.astrogeology.usgs.gov/Schemas/Application/application.xsd">

<brief>
Imports a Kaguya SP (Spectral Profiler) file
Imports a Kaguya SP (Spectral Profiler) file (deprecated)
Copy link
Contributor

Choose a reason for hiding this comment

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

We should list when it will be removed too.

Copy link
Contributor

Choose a reason for hiding this comment

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

@jessemapel No. Is there an appropriate way to announce or process to go through to indicate that something is deprecated? This is a bit of an odd situation in that the name of the program was changed years ago but the old version was not deleted, so it hasn't actually been supported/updated in some time.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Pretty sure it would require a RFC? Do we even have a plan for when/how this should be deprecated?

</brief>

<description>
<p>
<b>This is a deprecated. <a href="../kaguyasp2ascii/kaguyasp2ascii.html" target="_blank">kaguyasp2ascii</a> is a newer implementation of kaguyasp2isis, please use <a href="../kaguyasp2ascii/kaguyasp2ascii.html" target="_blank">kaguyasp2ascii</a> instead.</b>
Kelvinrr marked this conversation as resolved.
Show resolved Hide resolved
</p>
<p>
This program will import a Kaguya SP (Spectral Profiler) file to a tab delimited text file.
The text file will contain one record for each wavelength in the SP file. There are 296
Expand Down Expand Up @@ -35,8 +38,13 @@
</history>

<category>
<categoryItem>Utility</categoryItem>
<missionItem>Kaguya</missionItem>
</category>
<seeAlso>
<applications>
<item>kaguyasp2ascii</item>
</applications>
</seeAlso>

<groups>
<group name="Files">
Expand Down