search

shexSpec / shex

ShEx language issues, including new features for e.g. ShEx2.1
24 stars 8 forks source link

Changes since the last version #118

Open ericprud opened 2 years ago

ericprud commented 2 years ago

@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.

gkellogg commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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.