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

Swift: generate more QLdocs #14864

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Swift: generate more QLdocs #14864

wants to merge 9 commits into from

Conversation

redsun82
Copy link
Contributor

This not only generates all necessary QLdoc in generated files (which should fix the QL doc failure we get when adding new entities), but also patches already customized stubs with a QLdoc for the class, keeping it in sync with the schema file. That QLdoc is repeated in the generated class, but this repetition allows the users to get a nicer experience when hovering over a stub class name.

@redsun82 redsun82 requested a review from a team as a code owner November 21, 2023 16:54
@github-actions github-actions bot added the Swift label Nov 21, 2023
Copy link
Contributor

@geoffw0 geoffw0 left a comment

Choose a reason for hiding this comment

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

Thoughts / questions. I appreciate the progress we're making on this.

misc/codegen/templates/ql_stub_class_qldoc.mustache Outdated Show resolved Hide resolved
misc/codegen/generators/qlgen.py Outdated Show resolved Hide resolved
misc/codegen/generators/qlgen.py Outdated Show resolved Hide resolved
misc/codegen/test/test_render.py Show resolved Hide resolved
@redsun82 redsun82 added the no-change-note-required This PR does not need a change note label Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-change-note-required This PR does not need a change note Swift
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants