Skip to content

DOCS: doc grpc #1312

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

Merged
merged 124 commits into from
Jul 1, 2025

doc fix

6a1cc12
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

DOCS: doc grpc #1312

doc fix
6a1cc12
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale failed Jun 26, 2025 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (38)

doc/source/grpc_api/grpc/edb.rst|3 col 1| [Vale.Terms] Use 'EDB' instead of 'Edb'.
doc/source/grpc_api/grpc/edb.rst|3 col 1| [Google.Headings] 'Edb gRPC main class' should use sentence-style capitalization.
doc/source/grpc_api/index.rst|25 col 16| [Vale.Spelling] Did you really mean 'grpc'?
doc/source/grpc_api/index.rst|25 col 61| [Google.Will] Avoid using 'will'.
doc/source/grpc_api/index.rst|26 col 46| [Google.We] Try to avoid using first-person plural like 'we'.
doc/source/grpc_api/index.rst|26 col 49| [Google.Will] Avoid using 'will'.
doc/source/grpc_api/index.rst|27 col 15| [Google.Will] Avoid using 'will'.
doc/source/grpc_api/index.rst|27 col 76| [Google.Will] Avoid using 'will'.
doc/source/grpc_api/index.rst|28 col 49| [Google.We] Try to avoid using first-person plural like 'our'.
doc/source/grpc_api/index.rst|33 col 12| [Vale.Spelling] Did you really mean 'grpc'?
doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst|1 col 1| [Vale.Terms] Use 'RLC' instead of 'Rlc'.
doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst|1 col 1| [Google.Headings] 'Rlc' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/utility/xml_control_file.rst|3 col 28| [Vale.Terms] Use 'XML' instead of 'xml'.
doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst|1 col 1| [Vale.Terms] Use 'netlist' instead of 'Netlist'.
doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst|1 col 1| [Google.Headings] 'Netlist Model' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pin_pair_model.rst|1 col 1| [Google.Headings] 'Pin Pair Model' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/s_parameter_model.rst|1 col 1| [Google.Headings] 'S-Parameter model' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst|1 col 1| [Vale.Spelling] Did you really mean 'Pingroup'?
doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst|3 col 28| [Vale.Spelling] Did you really mean 'pingroup'?
doc/source/grpc_api/grpc/database/pyedb_lib/definition/component_def.rst|1 col 1| [Google.Headings] 'Component Definition' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/spice_model.rst|1 col 1| [Google.Headings] 'Spice Model' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/definition/package_def.rst|1 col 1| [Google.Headings] 'Package Definition' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/definition/padstack_def.rst|1 col 1| [Google.Headings] 'Padstack Definition' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/definition/materials.rst|1 col 1| [Google.Headings] 'Component Definition' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/geometry/arc_data.rst|1 col 1| [Google.Headings] 'Arc Data' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/layers/stackup_layer.rst|1 col 1| [Google.Headings] 'Stackup Layer' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/geometry/polygon_data.rst|1 col 1| [Google.Headings] 'Polygon Data' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_data.rst|1 col 1| [Google.Headings] 'Point Data' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_3d_data.rst|1 col 1| [Google.Headings] 'Point 3D data' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_advanced_settings.rst|1 col 1| [Google.Headings] 'Raptor X advanced settings' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_setup.rst|1 col 1| [Google.Headings] 'Raptor X simulation setup' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_general_settings.rst|1 col 1| [Google.Headings] 'Raptor X general settings' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_settings.rst|1 col 1| [Google.Headings] 'Raptor X simulation settings' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/terminal/pingroup_terminal.rst|1 col 1| [Vale.Spelling] Did you really mean 'Pingroup'?
doc/source/grpc_api/grpc/database/pyedb_lib/terminal/pingroup_terminal.rst|3 col 28| [Vale.Spelling] Did you really mean 'pingroup'?
doc/source/grpc_api/grpc/database/pyedb_lib/net/net_class.rst|1 col 1| [Google.Headings] 'Net Class' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/layout/voltage_regulator.rst|1 col 1| [Google.Headings] 'Voltage Regulator' should use sentence-style capitalization.
doc/source/grpc_api/grpc/database/pyedb_lib/net/differential_pair.rst|1 col 1| [Google.Headings] 'Differential Pair' should use sentence-style capitalization.

Filtered Findings (0)

Annotations

Check failure on line 3 in doc/source/grpc_api/grpc/edb.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/edb.rst#L3

[Vale.Terms] Use 'EDB' instead of 'Edb'.
Raw output
{"message": "[Vale.Terms] Use 'EDB' instead of 'Edb'.", "location": {"path": "doc/source/grpc_api/grpc/edb.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "ERROR"}

Check failure on line 3 in doc/source/grpc_api/grpc/edb.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/edb.rst#L3

[Google.Headings] 'Edb gRPC main class' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Edb gRPC main class' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/edb.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "ERROR"}

Check failure on line 25 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L25

[Vale.Spelling] Did you really mean 'grpc'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'grpc'?", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 25, "column": 16}}}, "severity": "ERROR"}

Check failure on line 25 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L25

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 25, "column": 61}}}, "severity": "ERROR"}

Check failure on line 26 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L26

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 26, "column": 46}}}, "severity": "ERROR"}

Check failure on line 26 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L26

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 26, "column": 49}}}, "severity": "ERROR"}

Check failure on line 27 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L27

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 27, "column": 15}}}, "severity": "ERROR"}

Check failure on line 27 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L27

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 27, "column": 76}}}, "severity": "ERROR"}

Check failure on line 28 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L28

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 28, "column": 49}}}, "severity": "ERROR"}

Check failure on line 33 in doc/source/grpc_api/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/index.rst#L33

[Vale.Spelling] Did you really mean 'grpc'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'grpc'?", "location": {"path": "doc/source/grpc_api/index.rst", "range": {"start": {"line": 33, "column": 12}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst#L1

[Vale.Terms] Use 'RLC' instead of 'Rlc'.
Raw output
{"message": "[Vale.Terms] Use 'RLC' instead of 'Rlc'.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst#L1

[Google.Headings] 'Rlc' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Rlc' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 3 in doc/source/grpc_api/grpc/database/pyedb_lib/utility/xml_control_file.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/utility/xml_control_file.rst#L3

[Vale.Terms] Use 'XML' instead of 'xml'.
Raw output
{"message": "[Vale.Terms] Use 'XML' instead of 'xml'.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/utility/xml_control_file.rst", "range": {"start": {"line": 3, "column": 28}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst#L1

[Vale.Terms] Use 'netlist' instead of 'Netlist'.
Raw output
{"message": "[Vale.Terms] Use 'netlist' instead of 'Netlist'.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst#L1

[Google.Headings] 'Netlist Model' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Netlist Model' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pin_pair_model.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pin_pair_model.rst#L1

[Google.Headings] 'Pin Pair Model' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Pin Pair Model' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pin_pair_model.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/s_parameter_model.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/s_parameter_model.rst#L1

[Google.Headings] 'S-Parameter model' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'S-Parameter model' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/s_parameter_model.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst#L1

[Vale.Spelling] Did you really mean 'Pingroup'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Pingroup'?", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 3 in doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst#L3

[Vale.Spelling] Did you really mean 'pingroup'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pingroup'?", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst", "range": {"start": {"line": 3, "column": 28}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/definition/component_def.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/definition/component_def.rst#L1

[Google.Headings] 'Component Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Component Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/definition/component_def.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/spice_model.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/spice_model.rst#L1

[Google.Headings] 'Spice Model' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Spice Model' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/spice_model.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/definition/package_def.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/definition/package_def.rst#L1

[Google.Headings] 'Package Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Package Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/definition/package_def.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/definition/padstack_def.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/definition/padstack_def.rst#L1

[Google.Headings] 'Padstack Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Padstack Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/definition/padstack_def.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/definition/materials.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/definition/materials.rst#L1

[Google.Headings] 'Component Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Component Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/definition/materials.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/grpc_api/grpc/database/pyedb_lib/geometry/arc_data.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/grpc_api/grpc/database/pyedb_lib/geometry/arc_data.rst#L1

[Google.Headings] 'Arc Data' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Arc Data' should use sentence-style capitalization.", "location": {"path": "doc/source/grpc_api/grpc/database/pyedb_lib/geometry/arc_data.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}