-
Notifications
You must be signed in to change notification settings - Fork 13
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
Updating README #71
Updating README #71
Conversation
Updating README.rst to include the changes to default behaviour
Fixed grammer. Added more examples for automatic header detection. Added linkable titles to some headings
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few remaining rst linting errors to fix. Two outstanding questions:
- from the UoD team, are there any objections to adopting the new behavior both in the context of IDR as well as the training? /cc @dominikl @pwalczysko
- should we get the new feature released as
0.10.0
or is it time to call this1.0.0
? If the latter was desirable but we felt like we need additional evaluation, an intermediate approach would be to get this as a pre-releases e.g.1.0.0a1
.
Thanks @muhanadz. This is now staged for review at https://github.com/ome/omero-metadata/blob/0cc977f9c4d2309b8712f2ef20ad93cba68295f2/README.rst. As mentioned above, next step is to get a sign off from the team and decide on the versioning/roadmap. |
Co-authored-by: pwalczysko <[email protected]>
Tested the examples listed for the automatic column detection (Project, Dataset, Screen and Image (adding roi table)). Worked fine. Happy to test the new @muhanadz 's examples too. |
Couple of suggestions, but looks good otherwise. |
Final read-through, looking good - couple of comments. |
Co-authored-by: pwalczysko <[email protected]>
Added final changes from comments and suggestions (thank you all). Made some changes to the object-types table to address the conversation here: #71 (comment) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks good now, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also happy for this to go in and I'll leave @pwalczysko to submit his review.
Once this is in, #77 is the only PR I would propose for review and possible inclusion in 0.11.0
as it fixes a specific (but not uncommon) use case related to the new detection feature. If there is no reviewing capacity, this can be scheduled for a patch release.
Sorry for the delay. Like the text, just one missing dot https://github.com/ome/omero-metadata/pull/71/files#r902463366 spotted. After accepting the suggestion https://github.com/ome/omero-metadata/pull/71/files#r902463366 all looks good to me here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix https://github.com/ome/omero-metadata/pull/71/files#r902463366 please, otherwise good to go.
Co-authored-by: pwalczysko <[email protected]>
Thanks all for the time spent on this readme. Lots of back n forth but i think in addition to introducing the new detection, the readme now clarifies several behaviors of the plugin. From my side the only blocker to releasing 0.11.0 is the scenario of csv files with sparse numerical data which is currently broken when using the default command (see #76). #77 proposes a fix for this regression by adding a new parameter in the HeaderDetection API. @will-moore @muhanadz could you take a look at this and see if the proposal makes sense? |
Updating README.rst to include the changes to the default behavior from #67.