-
Notifications
You must be signed in to change notification settings - Fork 312
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
Move ast and specification release notes into separate directories #519
Conversation
…the ast/spec reports
…h release notes getting updated
…em with release notes
I have an example version of a publishable build using this branch available at https://mbhealy.github.io/ currently. The release notes in the 3.0 and 3.1 versions don't contain anything currently because we would need to backport this PR there first. |
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.
Looks good to me. Not really an issue for this PR but I wondered if things might be clearer if we move the code for the Python package out from the current source
directory (which contains the spec and .rst
files). In a world where we had something like two disjoint directories
spec/
ast/
then e.g. we could have release notes for each stored in these. There is a common dependence on the ANTLR grammar, so that would have to be sorted out.
Ok to merge, I assume? |
Summary
This is the second of two options for handling separate AST/grammar and specification release notes using reno. The first is #518 .
Details and comments
In this version I have created new directories
spec_releasenotes
andast_releasenotes
and separated the existing notes between the two. I have also updated the contributing guidelines appropriately and the script that checks that a reno note has been created whenever there are changes in the source directory.