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.

Sign up for GitHub

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

Jump to bottom

[codegen] Improve generated docs for typed offset getters #684

Merged
merged 1 commit into from
Nov 2, 2023
Merged

[codegen] Improve generated docs for typed offset getters #684

merged 1 commit into from
Nov 2, 2023

Conversation

cmyr
Copy link
Member

@cmyr cmyr commented Oct 31, 2023 •
edited
Loading

motivated by #681

@rsheeter
Copy link
Collaborator

I think this is an improvement but I'm not sold it closes the issue. I would ideally like at least one of the following to close:

  • Say which specific thing to get the data from
  • Resolve the issue of being trivially able to pass the wrong data
    • Could we use the type system here?
    • If, for example, mark_anchor(data) took a data typed MarkArrayData it would be trivial to find where to get one of those.

rsheeter
rsheeter approved these changes Oct 31, 2023
View reviewed changes
Copy link
Collaborator

@rsheeter rsheeter left a comment

Choose a reason for hiding this comment

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

LGTM but I suggest not closing the issue

@cmyr
[codegen] Improve generated docs for typed offset getters
259b125 
[codegen] Also just reproduce the original docs when needed

More improvements to offset getter docs

- manually update codegen inputs to name parent field where it was
  missing
- simplify docs in case where manual data is required
@cmyr cmyr force-pushed the improve-typed-offset-getter-docs branch from ece8f27 to 259b125 Compare November 1, 2023 16:20
@cmyr cmyr merged commit 6392d83 into main Nov 2, 2023
8 checks passed
@cmyr cmyr deleted the improve-typed-offset-getter-docs branch November 2, 2023 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsheeter rsheeter rsheeter approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cmyr @rsheeter