From aeb63393e6a956192b6a21f1b7308a299d12f51d Mon Sep 17 00:00:00 2001 From: Nayane Fernandes <143632290+ansnfernand@users.noreply.github.com> Date: Fri, 20 Oct 2023 14:01:00 +0200 Subject: [PATCH 1/2] Updating API documentation Feedbacks from Pouya --- doc/source/user_guide/index.rst | 4 ++-- src/ansys/sherlock/core/lifecycle.py | 2 +- src/ansys/sherlock/core/parts.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 53b90b6cc..617507544 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -82,8 +82,8 @@ This code uses the Sherlock Part Library to update the parts list: "Tutorial", "Main Board", "Sherlock Part Library", - "Both", - "Error" + UpdatesPartsListRequestMatchingMode.BOTH, + UpdatesPartsListRequestDuplicationMode.ERROR ) For information on the ``parts`` module and its methods, see :ref:`ref_parts_module`. diff --git a/src/ansys/sherlock/core/lifecycle.py b/src/ansys/sherlock/core/lifecycle.py index a8b6c9f0a..87b134056 100644 --- a/src/ansys/sherlock/core/lifecycle.py +++ b/src/ansys/sherlock/core/lifecycle.py @@ -1227,7 +1227,7 @@ def add_harmonic_vibe_profiles( "Uniaxial", "2,4,5", ) - >>> sherlock.lifecycle.add_harmonic_profiles( + >>> sherlock.lifecycle.add_harmonic_vibe_profiles( "Test", [( "Example", diff --git a/src/ansys/sherlock/core/parts.py b/src/ansys/sherlock/core/parts.py index e9913b943..a071abae4 100644 --- a/src/ansys/sherlock/core/parts.py +++ b/src/ansys/sherlock/core/parts.py @@ -209,7 +209,7 @@ def update_parts_list( "Card", "Sherlock Part Library", PartsListSearchMatchingMode.BOTH, - PartsListSearchDuplicationMode.ERROR, + PartsListSearchDuplicationMode.ERROR ) """ try: From efca7f987a71c56bef27670a0c612eb4b7e38ef7 Mon Sep 17 00:00:00 2001 From: Nayane Fernandes <143632290+ansnfernand@users.noreply.github.com> Date: Mon, 23 Oct 2023 15:52:12 +0200 Subject: [PATCH 2/2] Fix: API documentation --- doc/source/user_guide/index.rst | 4 ++-- src/ansys/sherlock/core/parts.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 617507544..7e718335e 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -82,8 +82,8 @@ This code uses the Sherlock Part Library to update the parts list: "Tutorial", "Main Board", "Sherlock Part Library", - UpdatesPartsListRequestMatchingMode.BOTH, - UpdatesPartsListRequestDuplicationMode.ERROR + PartsListSearchMatchingMode.BOTH, + PartsListSearchDuplicationMode.ERROR, ) For information on the ``parts`` module and its methods, see :ref:`ref_parts_module`. diff --git a/src/ansys/sherlock/core/parts.py b/src/ansys/sherlock/core/parts.py index a071abae4..e9913b943 100644 --- a/src/ansys/sherlock/core/parts.py +++ b/src/ansys/sherlock/core/parts.py @@ -209,7 +209,7 @@ def update_parts_list( "Card", "Sherlock Part Library", PartsListSearchMatchingMode.BOTH, - PartsListSearchDuplicationMode.ERROR + PartsListSearchDuplicationMode.ERROR, ) """ try: