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

Add example to overlay_segments help text #3716

Merged
merged 10 commits into from
Dec 2, 2024

Conversation

ammar257ammar
Copy link
Contributor

This is related to Part 2 "Overlay segments" of pitch https://github.com/DIAGNijmegen/rse-roadmap/issues/362.

The overlay_segments is used in three places:

This PR adds a default JSON example and a link to documentation to the overlay_segments field.

@ammar257ammar ammar257ammar force-pushed the provide_example_for_overlay_segment branch from d270785 to 1f655aa Compare November 25, 2024 14:15
@ammar257ammar ammar257ammar force-pushed the provide_example_for_overlay_segment branch from bbd8cdb to 552e29c Compare November 25, 2024 15:52
@ammar257ammar ammar257ammar reopened this Nov 25, 2024
@ammar257ammar ammar257ammar force-pushed the provide_example_for_overlay_segment branch from 596625b to 77c0438 Compare November 25, 2024 16:32
@ammar257ammar ammar257ammar reopened this Nov 25, 2024
@ammar257ammar ammar257ammar self-assigned this Nov 26, 2024
@ammar257ammar ammar257ammar force-pushed the provide_example_for_overlay_segment branch from 403c696 to b9d54e8 Compare November 26, 2024 08:14
@ammar257ammar
Copy link
Contributor Author

Since the example added to the overlay_segments form field is fixed (hardcoded), is a form test still recommended to check it is there in the help_text?

@ammar257ammar ammar257ammar marked this pull request as ready for review November 27, 2024 12:40
@ammar257ammar ammar257ammar removed the request for review from jmsmkn November 27, 2024 12:45
@amickan
Copy link
Contributor

amickan commented Nov 28, 2024

Since the example added to the overlay_segments form field is fixed (hardcoded), is a form test still recommended to check it is there in the help_text?

No, we don't normally test static helptext.

@amickan amickan removed their assignment Nov 28, 2024
@ammar257ammar ammar257ammar self-assigned this Nov 28, 2024
@ammar257ammar ammar257ammar merged commit b32b8a4 into main Dec 2, 2024
8 checks passed
@ammar257ammar ammar257ammar deleted the provide_example_for_overlay_segment branch December 2, 2024 07:58
@ammar257ammar ammar257ammar removed their assignment Dec 2, 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