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

fix(compiler): inherit parent docstring in case no docstring was provided in child member #7172

Merged
merged 5 commits into from
Sep 27, 2024

Conversation

tsuf239
Copy link
Collaborator

@tsuf239 tsuf239 commented Sep 26, 2024

fixes: #6488

Checklist

  • Title matches Winglang's style guide
  • Description explains motivation and solution
  • Tests added (always)
  • Docs updated (only required for features)
  • Added pr/e2e-full label if this feature requires end-to-end testing

By submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.

@tsuf239 tsuf239 requested a review from a team as a code owner September 26, 2024 13:07
Copy link

Thanks for opening this pull request! 🎉
Please consult the contributing guidelines for details on how to contribute to this project.
If you need any assistance, don't hesitate to ping the relevant owner over Discord.

Topic Owner
Wing SDK and standard library @chriscbr
Wing Console @skyrpex
Wing compiler and language design @chriscbr
VSCode extension and language server @chriscbr
Wing CLI @chriscbr
Documentation @boyney123
Examples @boyney123
Wing Playground @skyrpex

@monadabot
Copy link
Contributor

monadabot commented Sep 26, 2024

Console preview environment is available at https://wing-console-pr-7172.fly.dev 🚀

Last Updated (UTC) 2024-09-27 02:41

@monadabot
Copy link
Contributor

Benchmarks

Comparison to Baseline ⬜⬜⬜⬜⬜⬜⬜⬜⬜🟥⬜⬜⬜
Benchmark Before After Change
version 57ms±0.52 57ms±0.63 0ms (-0.82%)⬜
hello_world.test.w -t sim 414ms±6.27 425ms±14.41 +11ms (+2.76%)⬜
hello_world.test.w -t tf-aws 1511ms±10.88 1526ms±11.84 +15ms (+1.02%)⬜
jsii_small.test.w -t sim 385ms±10.18 391ms±5.71 +6ms (+1.61%)⬜
jsii_small.test.w -t tf-aws 614ms±5.76 627ms±4.96 +14ms (+2.22%)⬜
jsii_big.test.w -t sim 3024ms±16.93 3060ms±18.63 +36ms (+1.18%)⬜
jsii_big.test.w -t tf-aws 3223ms±12.29 3231ms±19.48 +7ms (+0.22%)⬜
empty.test.w -t sim 375ms±3.02 378ms±2.95 +3ms (+0.82%)⬜
empty.test.w -t tf-aws 607ms±3.38 603ms±4.16 -4ms (-0.74%)⬜
functions_10.test.w -t sim 489ms±16.67 505ms±9.03 +16ms (+3.3%)🟥
functions_10.test.w -t tf-aws 2184ms±15.57 2202ms±12.23 +18ms (+0.81%)⬜
functions_1.test.w -t sim 416ms±5.34 411ms±4.53 -6ms (-1.39%)⬜
functions_1.test.w -t tf-aws 852ms±4.23 860ms±6.75 +8ms (+0.97%)⬜

⬜ Within 1.5 standard deviations
🟩 Faster, Above 1.5 standard deviations
🟥 Slower, Above 1.5 standard deviations

Benchmarks may vary outside of normal expectations, especially when running in GitHub Actions CI.

Results
name mean min max moe sd
version 57ms 55ms 58ms 1ms 1ms
hello_world.test.w -t sim 425ms 403ms 464ms 14ms 20ms
hello_world.test.w -t tf-aws 1526ms 1510ms 1569ms 12ms 17ms
jsii_small.test.w -t sim 391ms 383ms 409ms 6ms 8ms
jsii_small.test.w -t tf-aws 627ms 621ms 642ms 5ms 7ms
jsii_big.test.w -t sim 3060ms 3021ms 3107ms 19ms 26ms
jsii_big.test.w -t tf-aws 3231ms 3197ms 3295ms 19ms 27ms
empty.test.w -t sim 378ms 372ms 385ms 3ms 4ms
empty.test.w -t tf-aws 603ms 594ms 612ms 4ms 6ms
functions_10.test.w -t sim 505ms 485ms 529ms 9ms 13ms
functions_10.test.w -t tf-aws 2202ms 2173ms 2224ms 12ms 17ms
functions_1.test.w -t sim 411ms 400ms 421ms 5ms 6ms
functions_1.test.w -t tf-aws 860ms 846ms 875ms 7ms 9ms
Last Updated (UTC) 2024-09-26 13:20

Signed-off-by: monada-bot[bot] <[email protected]>
@monadabot monadabot added the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Sep 26, 2024
Copy link
Contributor

@Chriscbr Chriscbr left a comment

Choose a reason for hiding this comment

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

great test coverage! Thank you @tsuf239

@Chriscbr Chriscbr removed the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Sep 27, 2024
Signed-off-by: monada-bot[bot] <[email protected]>
@monadabot monadabot added the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Sep 27, 2024
@Chriscbr Chriscbr removed the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Sep 27, 2024
Copy link
Contributor

mergify bot commented Sep 27, 2024

Thanks for contributing, @tsuf239! This PR will now be added to the merge queue, or immediately merged if tsuf/render-child-docs is up-to-date with main and the queue is empty.

@mergify mergify bot merged commit bca2b7c into main Sep 27, 2024
15 checks passed
@mergify mergify bot deleted the tsuf/render-child-docs branch September 27, 2024 02:47
@monadabot
Copy link
Contributor

Congrats! 🚀 This was released in Wing 0.85.17.

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.

inherit parent docstring in case no docstring was provided in child member
3 participants