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

Better docs #24

Merged
merged 3 commits into from
Apr 24, 2024
Merged

Better docs #24

merged 3 commits into from
Apr 24, 2024

Conversation

tvt173
Copy link
Contributor

@tvt173 tvt173 commented Apr 24, 2024

Added docs to all the components. No functional changes

@tvt173 tvt173 requested a review from joamatab April 24, 2024 07:37
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @tvt173 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Docstrings: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Copy link
Contributor

@joamatab joamatab left a comment

Choose a reason for hiding this comment

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

looks great

it would be great to follow other gdsfactory docstrings

length (float, optional): the length of the taper, in um. Defaults to 10.0.

should be

length: the length of the taper, in um. Defaults to 10.0.

@joamatab joamatab merged commit 15e4149 into gdsfactory:main Apr 24, 2024
5 checks passed
@flaport
Copy link
Contributor

flaport commented Apr 24, 2024

@joamatab , can you make a release for this?

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.

3 participants