-
Notifications
You must be signed in to change notification settings - Fork 60
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 models/processes to overview #242
base: main-1.3
Are you sure you want to change the base?
Conversation
spec/1.3.0/spec.md
Outdated
|
||
# Chapter #. Processes | ||
The following diagram summarizes the three _information models_. |
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.
This sentence declares 3 things, but then 4 things are listed below.
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.
That's original text, but it does look especially dubious in the new context. I've reworded it for now.
In the future, I'm not sure that it's helpful to have the presentation stream stuff in the combined diagram, but that's for another time.
fbeac82
to
cc49edb
Compare
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.
The language changes here seem fine, but I'm starting to get the feeling that this informative text really ought to go into a separate document than the spec itself. Or is there some way in which any of this actually affects how YAML is handled?
What I'm envisioning here is that there could be a separate treatise on "This is how most YAML processors do things." This could help in reducing the size of the actual spec.
I generally agree. I think that in this case there is value to having a quick, formal-but-not-complete listing of the information models and processes before the detailed descriptions in the chapters. This PR adds text, but I'm hoping that having a concise introduction here will help us to remove redundant text elsewhere. |
I'd like to propose slowing down on shaping the 1.3 spec until we know more clearly what we are intending to specify. In my current opinion, the successful rollout of YAML 1.3 depends on several things including:
etc. I feel like at this point we need to flesh out these ideas to get a clearer vision of what 1.3 will be, before we spend much more time of the spec. For instance re #241, I'd like to see published documentation that replaces anything we want to remove. Let's hold off on merging this #241 and #242 for now... We can continue to make low hanging, non-contentious modifications to the productions, but the overall shape of the informative parts will be more obvious after we make progress on the other fronts. |
Add a short introduction to the data models and processes in the language overview. The new descriptions are meant to be formally correct, but high-level and incomplete. This is in preparation for expanding the model and process sections into full individual chapters.
By submitting this pull request, I confirm that you can use, modify, copy, and
redistribute this contribution, under the terms of your choice.