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 docstring #519

Merged
merged 1 commit into from
Dec 21, 2024
Merged

fix docstring #519

merged 1 commit into from
Dec 21, 2024

Conversation

joamatab
Copy link
Contributor

@joamatab joamatab commented Dec 21, 2024

Summary by Sourcery

Clarify docstrings in initialize_sde and write_sde to specify parameter types and add missing parameter descriptions. Update tests to include assertions.

Documentation:

  • Improve documentation for initialize_sde and write_sde parameters.

Tests:

  • Add assertions to tests in test_materials.py.

@joamatab joamatab added the documentation Improvements or additions to documentation label Dec 21, 2024
Copy link
Contributor

sourcery-ai bot commented Dec 21, 2024

Reviewer's Guide by Sourcery

This pull request fixes the docstrings in the sde.py and test_materials.py files.

Class diagram showing updated function signatures in sde.py

classDiagram
    class sde {
        +initialize_sde(component, waferstack, layermap, xsection_bounds, u_offset, round_tol, simplify_tol, header_str) str
        +write_sde(component, waferstack, layermap, process, contact_str, slice_str, init_tdr, save_directory, execution_directory, filename, fileout, round_tol, simplify_tol, device_remesh, remesh_str, header_str, num_threads) void
    }
    note for sde "Docstring updates for better parameter documentation"
Loading

File-Level Changes

Change Details Files
Fixed docstrings in initialize_sde function.
  • Clarified the description of the component argument.
  • Fixed the description of the xsection_bounds argument.
  • Removed the description of the process argument.
  • Added descriptions for the round_tol, simplify_tol, and header_str arguments.
gplugins/sentaurus/sde.py
Fixed docstrings in write_sde function.
  • Clarified the descriptions of the component, waferstack, layermap, and process arguments.
  • Added descriptions for the contact_str, slice_str, and init_tdr arguments.
  • Removed descriptions for the u_offset, filename, struct_prefix, structout, contact_portnames, split_steps, init_lines, initial_z_resolutions, initial_xy_resolution, and global_device_remeshing_str arguments.
  • Added descriptions for the fileout, round_tol, simplify_tol, device_remesh, remesh_str, and header_str arguments.
gplugins/sentaurus/sde.py
Fixed assertions in tests.
  • Added assertions to check the _data attribute of the strip object in multiple test cases.
gplugins/tidy3d/tests/test_materials.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@joamatab joamatab requested a review from simbilod December 21, 2024 01:16
@joamatab joamatab merged commit 7ed2b30 into main Dec 21, 2024
9 of 13 checks passed
@joamatab joamatab deleted the minor_ruff_fixes branch December 21, 2024 01:16
Copy link
Contributor

@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.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

@github-actions github-actions bot added the bug Something isn't working label Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant