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(docs): python docs for aspect #3002

Merged
merged 4 commits into from
Jul 21, 2023

Conversation

gertzakis
Copy link
Contributor

Related issue

Fixes #

Description

I noticed that the documentation for Aspects in Python is not so easily understood. The reason is that it should call the Aspect class with the stack instance.

Checklist

  • I have updated the PR title to match CDKTF's style guide
  • I have run the linter on my code locally
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation if applicable
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works if applicable
  • New and existing unit tests pass locally with my changes

@gertzakis gertzakis requested review from a team as code owners July 12, 2023 07:58
@gertzakis gertzakis requested review from ansgarm and DanielMSchmidt and removed request for a team July 12, 2023 07:58
@hashicorp-cla
Copy link

hashicorp-cla commented Jul 12, 2023

CLA assistant check
All committers have signed the CLA.

@ansgarm
Copy link
Member

ansgarm commented Jul 12, 2023

Hi @gertzakis 👋

Thank you for the PR 👍 Unfortunately, the source of truth for these snippets is in this file and your changes in this PR would be overridden the next time we run yarn generate-docs:translations. We run these examples in CI to ensure the example code works.

You can add your changes over there and use the DOCS_BLOCK_START and _END markers to include the existing stack where required 😇

@gertzakis
Copy link
Contributor Author

Hello @ansgarm, thank you for clarifying this. I changed it, please check again :)

Copy link
Member

@ansgarm ansgarm left a comment

Choose a reason for hiding this comment

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

Thank you @gertzakis 💯

@ansgarm ansgarm changed the title fix python docs for aspect fix(docs): python docs for aspect Jul 21, 2023
@ansgarm ansgarm merged commit 89cde1b into hashicorp:main Jul 21, 2023
72 of 76 checks passed
@github-actions
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2023
@gertzakis gertzakis deleted the fix-python-aspect-example branch August 21, 2023 06:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants