Add summary of capabilities/user stories to docs index page #149
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #149 +/- ##
==========================================
+ Coverage 72.60% 75.46% +2.86%
==========================================
Files 9 9
Lines 646 693 +47
==========================================
+ Hits 469 523 +54
+ Misses 177 170 -7
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ojustino
reviewed
Nov 23, 2022
There was a problem hiding this comment.
Hi @rosteen, thanks for the pull request. I like the content and think it would be good to rearrange it. My suggestions:
- Leave the first sentence as is ("The specreduce package aims...").
- Combine the beginning of the second sentence (up to "...basic spectroscopic reduction") and your first sentence ("Specreduce is currently useful...") into something like "Specreduce is currently most useful for the following steps in basic spectroscopic reduction:"
- Leave your numbered list as is.
- Paste the rest of the original second sentence after the list – I think it's better to list what we can't do and where else to go only after what we've given details on what we can do.
|
@ojustino I made some edits, does it sound better to you now? |
ojustino
reviewed
Nov 29, 2022
docs/index.rst
Outdated
| basic spectroscopic reduction, currently encompassing the following three tasks: | ||
|
|
||
| #. Determining the trace of a spectrum dispersed in a 2D image, either by setting a flat | ||
| trace or fitting a spline, polynomial, or other model to the positions of the dispersed |
There was a problem hiding this comment.
I would also add that users can set a custom trace so ArrayTrace isn't left out.
Co-authored-by: ojustino <ojustino@users.noreply.github.com>
|
@ojustino I put in all your suggestions, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As it says in the title - I hope that this is something close to what you were imagining for the "user stories" on the docs landing page, to give people an idea of what they might use
specreducefor. If I'm off the mark let me know.