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

Correct inconsistent casing of fdc3.timeRange #1240

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

kriswest
Copy link
Contributor

The fdc3.timeRange context type is inconsistently cased in the FDC3 docs and codebase, sometimes appearing as fdc3.timerange. This PR corrects it such that it appears as fdc3.timeRange in all cases.

Once approved the commit from this PR will need to be cherry-picked into a release/2.1.1 branch to release a corrected version of the 2.1 npm module.

@kriswest kriswest requested review from a team June 28, 2024 14:16
Copy link

netlify bot commented Jun 28, 2024

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit 89d5cca
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/667ec5be3c5be2000858eb97
😎 Deploy Preview https://deploy-preview-1240--fdc3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@bingenito bingenito mentioned this pull request Jun 28, 2024
18 tasks
@bingenito
Copy link
Member

I added a reference from the task items for fdc3-dotnet 2.1 update to also fix this.

Copy link
Member

@bingenito bingenito left a comment

Choose a reason for hiding this comment

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

Seems that a majority of the implementation was all lower so I wonder if it would have made sense to stick to that in all cases, but for consistency across the API the camel casing makes more sense. I expect most usage is through the enum/constant declarations that are exported and not string literal hardcoding.

@kriswest
Copy link
Contributor Author

Seems that a majority of the implementation was all lower so I wonder if it would have made sense to stick to that in all cases, but for consistency across the API the camel casing makes more sense. I expect most usage is through the enum/constant declarations that are exported and not string literal hardcoding.

I agonized over that too - will the types have taken precedence or the examples and FDC3 workbench? In almost every cases there was a conflicting one on the same page or in the same schema. I decided to go with consistency with the rest of the standard in the end as I don't know that this type is heavily used as yet (it was originally created to support the fdc3.chart type). If we're ever going to correct it to be consistent, sooner is better.

I could add an admonition to the ref page for it, high;ighting the fact it had to be fixed...

@kriswest kriswest merged commit 6771208 into main Jul 4, 2024
10 checks passed
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.

3 participants