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

DM-41063: Update docstring for DiaSource.ext_trailedSources_Naive_flag_edge #191

Merged
merged 1 commit into from
May 8, 2024

Conversation

bsmartradio
Copy link
Contributor

@bsmartradio bsmartradio commented Mar 6, 2024

The docstring for DiaSource.ext_trailedSources_Naive_flag_edge has been updated to reflect that it only indicates whether or not a trailed source's endpoints contain edge pixels. Other flags pertaining to trailed sources will not be persisted at this time and are only used for filtering purposes in filterDiaSourceCatalog.py in ap_association.

Copy link
Collaborator

@gpdf gpdf left a comment

Choose a reason for hiding this comment

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

This is just a comment, not an objection.

These column names are starting to get very long, sometimes more than 50% of the length of the description. Long column names are not going to be super-popular with users creating ADQL queries, and they also don't lead to a great UX in a visualization, because either one displays the whole string -- with associated distortions of the UI, like very wide columns that only have 'T' or 'F' in them -- or some generic truncation of it, which might not be nearly as informative as a deliberately constructed shorter name.

Note that the description string is available in almost every context, Portal, PyVO, TOPCAT, etc.

I'm not requesting changes because we don't have a stated maximum length and we also haven't leaned hard on this in the past, but it would be good to think it through.

@bsmartradio bsmartradio requested a review from mrawls March 7, 2024 19:09
@bsmartradio bsmartradio force-pushed the tickets/DM-41063 branch 2 times, most recently from c2ceac7 to 33810bb Compare April 18, 2024 16:35
@bsmartradio bsmartradio force-pushed the tickets/DM-41063 branch 4 times, most recently from cb20aa2 to 8914c7b Compare April 28, 2024 18:55
@JeremyMcCormick JeremyMcCormick self-requested a review May 3, 2024 03:03
yml/imsim.yaml Outdated
datatype: boolean
description: This flag is set if a trailed source end points contains a nan.
fits:tunit:
mysql:datatype: BOOLEAN
Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick May 3, 2024

Choose a reason for hiding this comment

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

Please remove all of these mysql:datatype: BOOLEAN overrides (including the two below) as they are now redundant with datatype: boolean and will be flagged in the validation as errors in the near future.

@JeremyMcCormick
Copy link
Collaborator

@bsmartradio You should pull recent updates to main and rebase your branch. Otherwise you are going to see erroneous validation errors in some of the other schemas.

@gpdf
Copy link
Collaborator

gpdf commented May 3, 2024

@bsmartradio You should pull recent updates to main and rebase your branch. Otherwise you are going to see erroneous validation errors in some of the other schemas.

And it looks like you can ultimately squash the three commits that are currently on this branch.

@gpdf
Copy link
Collaborator

gpdf commented May 7, 2024

The current state of this PR appears to be that it only changes one line of code, the description for the column DiaSource.ext_trailedSources_Naive_flag_edge . Is that correct or is the branch still in flux?

@bsmartradio
Copy link
Contributor Author

bsmartradio commented May 7, 2024 via email

@bsmartradio bsmartradio changed the title DM-41063: Add nan, suspect_long_trial, and off_image flags DM-41063: Update docstring for DiaSource.ext_trailedSources_Naive_flag_edge May 7, 2024
@JeremyMcCormick
Copy link
Collaborator

JeremyMcCormick commented May 8, 2024

This is still in flux as the other 5 PR's related to it are still in the works. This will likely be the only change and this PR will be updated.

This is such a minor change that it should just be rolled into some other update or put on a user branch. We only really merge ticket branches like this when they resolve the connected Jira issue, and we don't reuse branch names or generally allow merging the same branch more than once.

5 PR's related to it are still in the works

It would be my preference that these are split into separate Jira issues and ticket branches. For anything but trivial changes we aim for a one-to-one correspondence between PRs and tickets on this project. There are exceptions when applying a small patch/fix/update to an already merged branch (with branch naming like DM-12345-fixed-something) or making minor updates on a user branch, but generally this would be a good pattern to follow for organizational purposes. It is also crucial for generating easily understandable release notes where each item should correspond to a resolved ticket.

@bsmartradio
Copy link
Contributor Author

This is still in flux as the other 5 PR's related to it are still in the works. This will likely be the only change and this PR will be updated.

This is such a minor change that it should just be rolled into some other update or put on a user branch. We only really merge ticket branches like this when they resolve the connected Jira issue, and we don't reuse branch names or generally allow merging the same branch more than once.

5 PR's related to it are still in the works

It would be my preference that these are split into separate Jira issues and ticket branches. For anything but trivial changes we aim for a one-to-one correspondence between PRs and tickets on this project. There are exceptions when applying a small patch/fix/update to an already merged branch (with branch naming like DM-12345-fixed-something) or making minor updates on a user branch, but generally this would be a good pattern to follow for organizational purposes. It is also crucial for generating easily understandable release notes where each item should correspond to a resolved ticket.

I believe there may be some confusion, the other 5 PR's are the related ticket work for DM-41063 are in other packages. We are changing how the edge flag works and what it means across multiple packages to make it more specific when we filter the trailed sources. Naturally, this means that the docstring for the flag needs to be updated as it no longer is accurate since it now no longer indicates off image trails. If you still feel this requires a user branch, I can do that, but this is directly related to the edge flag change and migration in ticket DM-41063.

Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick left a comment

Choose a reason for hiding this comment

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

Holding temporarily until I understand if this is actually resolving the referenced ticket, since the original PR had actual changes to the schema that added additional columns.

Don't these columns still need to be added to the schema to resolve the ticket? Or was it decided not to include them?

Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick left a comment

Choose a reason for hiding this comment

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

@bsmartradio indicated that the additional columns on the schemas were no longer needed and this PR resolves the work for the ticket on this repo.

@bsmartradio bsmartradio merged commit be3d6b7 into main May 8, 2024
4 checks passed
@bsmartradio bsmartradio deleted the tickets/DM-41063 branch May 8, 2024 20:43
@gpdf
Copy link
Collaborator

gpdf commented Jun 28, 2024

@bsmartradio We just noticed that the description change in this ticket was applied only to imsim.yaml and not to the same DiaSource.trail_flag_edge attribute in apdb.yaml. Was this an oversight?

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.

4 participants