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

Add HTML ids for object definitions in the formatted specification #1174

Merged
merged 8 commits into from Jul 19, 2022

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Jul 19, 2022

I want to be able to hyperlink between the various object definitions in the spec. By way of a start, let's give each of the generated <table>s an id.

Suggest reviewing this commit-by-commit. It's not terribly complicated, but the total diff isn't that easy to follow.

Also, for easy reference, the diff in the generated spec: spec.diff.txt

Preview: https://pr1174--matrix-spec-previews.netlify.app

All of the callers to resolve-additional-types already call resolve-allof (or
if not, they should), so this is redundant.
I want to add more params to this, so first make it take a dict.
... which means we can use the result from resolve-additional-types directly.
This means that it will generate an anchor for each type, whihc will then be
passed into render-object-table and used as an `id` for the table.
@richvdh richvdh requested a review from a team as a code owner July 19, 2022 19:00
Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

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

seems sensible.

Keen to get this merged as for some reason the branch name is showing up in my git error logs 🙃

@turt2live
Copy link
Member

I'm merging this out of desperation for local git problems.

@turt2live turt2live merged commit 5f3b344 into main Jul 19, 2022
@turt2live turt2live deleted the rav/hyperlink_object_titles/work branch July 19, 2022 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants