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

Remove now outdated paragraphs from Versions section #3219

Closed
wants to merge 1 commit into from
Closed

Remove now outdated paragraphs from Versions section #3219

wants to merge 1 commit into from

Conversation

ralfhandl
Copy link
Contributor

Fixes #3195

Alternative to #3214

Copy link
Member

@handrews handrews left a comment

Choose a reason for hiding this comment

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

Do we wan to remove this entirely, or explain the exception for OAS 3.0 to OAS 3.1. Either way, I agree it needs to change, and this change would work for me.

@MikeRalphson
Copy link
Member

I'm against this change. The 3.0 series of releases has their rules / had them at the time of writing.

@ralfhandl
Copy link
Contributor Author

The well-intended 3.0 rules clearly have joined the dinosaurs now, and retaining them in a document published after their demise is really confusing.

@handrews
Copy link
Member

handrews commented May 5, 2023

@MikeRalphson what about instead adding a note that this policy was changed in 3.1.0 and referring readers to that document for further details? That would leave the policy as defined in place, but correctly set expectations that it has not been followed exactly.

@MikeRalphson
Copy link
Member

It feels odd to me that a 3.0.x document 'knows about' a 3.1.x document, even if it post-dates it. I think that's my gut objection.

@handrews
Copy link
Member

handrews commented May 5, 2023

I think the important thing here is the UX more than forward knowledge. The current text sets an incorrect expectation which is very bad UX.

@ralfhandl
Copy link
Contributor Author

Closed in favor of #3214 after discussion in TDC

@ralfhandl ralfhandl closed this Feb 8, 2024
@ralfhandl ralfhandl deleted the fix/3195-remove-now-incorrect-paragraphs branch February 8, 2024 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification requests to clarify, but not change, part of the spec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants