ansys / ansys/pyedb-core

Documentation specify layer name while Layer object is expected

Open
#475 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
7
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### Description of the modifications

https://edb.core.docs.pyansys.com/version/stable/api/_autosummary/ansys.edb.core.layer.layer_collection.LayerCollection.add_layer_top.html#ansys.edb.core.layer.layer_collection.LayerCollection.add_layer_top

When we pass the layer name we got str doesn't have msg, we actually need to pass a StackupLayer object.

### Useful links and references

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the linked API documentation for LayerCollection.add_layer_top and inspect how the layer parameter is described. Update the documentation to state that a StackupLayer object is expected rather than a layer name, then verify the rendered parameter description matches the method behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.