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

Changes since the last version #118

Open
ericprud opened this issue Feb 2, 2022 · 3 comments
Open

Changes since the last version #118

ericprud opened this issue Feb 2, 2022 · 3 comments
Assignees
Labels

Comments

@ericprud
Copy link
Contributor

ericprud commented Feb 2, 2022

@gkellogg asked for this and it seems especially important given that a proposed definition for extends adds a parameter to satisfies. @gkellogg , have you got a good tool? Diffs like this tend to mangle <pre/>s. Also, I don't know how to point it at e.g. the 2.1 spec and the extends-new-param branch. (The first step is probably to finalize 2.1 and give it a maintenance branch like 2.0.)

Barring a good enough tool, we can do the job a couple times by hand as we finalize 2.2.

@ericprud ericprud added the spec label Feb 2, 2022
@ericprud ericprud self-assigned this Feb 2, 2022
@gkellogg
Copy link
Contributor

gkellogg commented Feb 2, 2022

IMO, diffs are actually less useful than an appendix summarizing the change with a reference to the associated PR. PR Preciew does a good job of a diff for that specific change. I think it still uses Shane’s original htmldiff tool.

@ericprud
Copy link
Contributor Author

ericprud commented Feb 2, 2022

Makes sense. I think the appendix can say "there's an extra parameter at the end or satisfies" but it might be nice to see that highlighted in the text as well.

@gkellogg
Copy link
Contributor

gkellogg commented Feb 3, 2022

I think The ReSpec team is working on a way to automate this for spec updates. It’s complicated by the new process document which didn’t consider the need of tooling or the burden on editors sufficiently. But, it seems like a good workflow to just list the PRs from the original spec to the updated version and let the tools just do the right thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants