Fix docstrings to reference datatype as it would be used for users

src/ifcopenshell-python/ifcopenshell/api/sequence/add_task.py

@@ -67,11 +67,11 @@ class Usecase:
         :param work_schedule: The work schedule to group the task in, if the
             task is to be a top-level or root task. This is mutually exclusive
             with the parent_task parameter.
-        :type work_schedule: ifcopenshell.entity_instance.entity_instance
+        :type work_schedule: ifcopenshell.entity_instance
         :param parent_task: The parent task, if the task is to be a subtask or
             child task. This is mutually exclusive with the work_schedule
             parameter.
-        :type parent_task: ifcopenshell.entity_instance.entity_instance
+        :type parent_task: ifcopenshell.entity_instance
         :param name: The name of the task.
         :type name: str,optional
         :param description: The description of the task.
@@ -83,7 +83,7 @@ class Usecase:
             IFC documentation for IfcTaskTypeEnum for more information.
         :type predefined_type: str
         :return: The newly created IfcTask
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/add_task_time.py

@@ -27,11 +27,11 @@ class Usecase:
         (especially for maintenance tasks).
 
         :param task: The task to add time data to.
-        :type task: ifcopenshell.entity_instance.entity_instance
+        :type task: ifcopenshell.entity_instance
         :param is_recurring: Whether or not the time should recur.
         :type is_recurring: bool
         :return: The newly created IfcTaskTime.
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/add_time_period.py

@@ -39,7 +39,7 @@ class Usecase:
 
         :param recurrence_pattern: The IfcRecurrencePattern to add the time
             period to. See ifcopenshell.api.sequence.assign_recurrence_pattern.
-        :type recurrence_pattern: ifcopenshell.entity_instance.entity_instance
+        :type recurrence_pattern: ifcopenshell.entity_instance
         :param start_time: The start time of the time period, in a format
             compatible with IfcTime, such as an ISO format time string or a
             datetime.time object.
@@ -49,7 +49,7 @@ class Usecase:
             datetime.time object.
         :type end_time: str,datetime.time
         :return: The newly created IfcTimePeriod
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_calendar.py

@@ -41,7 +41,7 @@ class Usecase:
             specifically define shifts, such as FIRSTSHIFT, SECONDSHIFT, or
             THIRDSHIFT. Leave as NOTDEFINED for basic calendar usage.
         :return: The newly created IfcWorkCalendar
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_plan.py

@@ -42,7 +42,7 @@ class Usecase:
             within the work plan are relevant.
         :type start_time: str,datetime.time
         :return: The newly created IfcWorkPlan
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_schedule.py

@@ -50,9 +50,9 @@ class Usecase:
             provided, the schedule will not be grouped in a work plan and would
             exist as a top level schedule in the project. This is not
             recommended.
-        :type work_plan: ifcopenshell.entity_instance.entity_instance,optional
+        :type work_plan: ifcopenshell.entity_instance,optional
         :return: The newly created IfcWorkSchedule
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_time.py

@@ -31,12 +31,12 @@ class Usecase:
 
         :param work_calendar: The IfcWorkCalendar to add the work or holiday
             time definition to.
-        :type work_calendar: ifcopenshell.entity_instance.entity_instance
+        :type work_calendar: ifcopenshell.entity_instance
         :param time_type: Either WorkingTimes or ExceptionTimes, depending on
             what you want to define.
         :type time_type: str
         :return: The newly created IfcWorkTime
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/assign_lag_time.py

@@ -33,7 +33,7 @@ class Usecase:
         are allowed.
 
         :param rel_sequence: The IfcRelSequence to assign the lag time to.
-        :type rel_sequence: ifcopenshell.entity_instance.entity_instance
+        :type rel_sequence: ifcopenshell.entity_instance
         :param lag_value: An ISO standardised duration string.
         :type lag_value: str
         :param duration_type: Choose from WORKTIME for the associated
@@ -43,7 +43,7 @@ class Usecase:
             is unclear.
         :type duration_type: str
         :return: The newly created IfcLagTime
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/assign_process.py

@@ -61,12 +61,12 @@ class Usecase:
 
         :param relating_process: The IfcProcess (typically IfcTask) that the
             input, control, or resource is related to.
-        :type relating_process: ifcopenshell.entity_instance.entity_instance
+        :type relating_process: ifcopenshell.entity_instance
         :param related_object: The IfcProduct (for input), IfcCostItem (for
             control) or IfcConstructionResource (for resource).
-        :type related_object: ifcopenshell.entity_instance.entity_instance
+        :type related_object: ifcopenshell.entity_instance
         :return: The newly created IfcRelAssignsToProcess relationship
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/assign_product.py

@@ -37,12 +37,12 @@ class Usecase:
 
         :param relating_product: The IfcProduct that was constructed as a result
             of the task.
-        :type relating_product: ifcopenshell.entity_instance.entity_instance
+        :type relating_product: ifcopenshell.entity_instance
         :param related_object: The IfcProcess (typically IfcTask) of the
             construction task.
-        :type related_object: ifcopenshell.entity_instance.entity_instance
+        :type related_object: ifcopenshell.entity_instance
         :return: The newly created IfcRelAssignsToProduct relationship
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/assign_recurrence_pattern.py

@@ -60,11 +60,11 @@ class Usecase:
         :param parent: Either an IfcTaskTimeRecurring if you are defining a
             recurring schedule for a task, or IfcWorkTime if you are defining a
             recurring pattern for a workdays or holidays in a calendar.
-        :type parent: ifcopenshell.entity_instance.entity_instance
+        :type parent: ifcopenshell.entity_instance
         :param recurrence_type: One of the types of recurrences.
         :type recurrence_type: str
         :return: The newly created IfcRecurrencePattern
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/assign_sequence.py

@@ -51,13 +51,13 @@ class Usecase:
         predecessor and successor tasks in the planning profession.
 
         :param relating_process: The previous / predecessor task.
-        :type relating_process: ifcopenshell.entity_instance.entity_instance
+        :type relating_process: ifcopenshell.entity_instance
         :param related_process: The next / successor task.
-        :type related_process: ifcopenshell.entity_instance.entity_instance
+        :type related_process: ifcopenshell.entity_instance
         :param sequence_type: Choose from FINISH_START, FINISH_FINISH,
             START_START, or START_FINISH.
         :return: The newly created IfcRelSequence
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/assign_workplan.py

@@ -29,11 +29,11 @@ class Usecase:
 
         :param work_schedule: The IfcWorkSchedule that will be assigned to the
             work plan.
-        :type work_schedule: ifcopenshell.entity_instance.entity_instance
+        :type work_schedule: ifcopenshell.entity_instance
         :param work_plan: The IfcWorkPlan for the schedule to be assigned to.
-        :type work_plan: ifcopenshell.entity_instance.entity_instance
+        :type work_plan: ifcopenshell.entity_instance
         :return: The IfcRelAggregates relationship
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/calculate_task_duration.py

@@ -36,7 +36,7 @@ class Usecase:
         then nothing happens.
 
         :param task: The IfcTask to calculate the duration for.
-        :type task: ifcopenshell.entity_instance.entity_instance
+        :type task: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/cascade_schedule.py

@@ -42,7 +42,7 @@ class Usecase:
         be equivalent to be Tuesday 8am, for instance.
 
         :param task: The start task to begin cascading from.
-        :type task: ifcopenshell.entity_instance.entity_instance
+        :type task: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/create_baseline.py

@@ -37,9 +37,9 @@ class Usecase:
         * Same Resource Relationships
 
         :param work_schedule: The planned work_schedule to baseline
-        :type work_schedule: ifcopenshell.entity_instance.entity_instance
+        :type work_schedule: ifcopenshell.entity_instance
         :return: The baseline work_schedule
-        :rtype: ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance
 
         Example:
         .. code:: python

src/ifcopenshell-python/ifcopenshell/api/sequence/duplicate_task.py

@@ -33,9 +33,9 @@ class Usecase:
         * The copy will have duplicated nested tasks
 
         :param task: The task to be duplicated
-        :type task: ifcopenshell.entity_instance.entity_instance
+        :type task: ifcopenshell.entity_instance
         :return: The duplicated task or the list of duplicated tasks if the latter has children
-        :rtype: ifcopenshell.entity_instance.entity_instance or list of ifcopenshell.entity_instance.entity_instance
+        :rtype: ifcopenshell.entity_instance or list of ifcopenshell.entity_instance
 
         Example:
         .. code:: python

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_lag_time.py

@@ -28,7 +28,7 @@ class Usecase:
         IfcLagTime, consult the IFC documentation.
 
         :param lag_time: The IfcLagTime entity you want to edit
-        :type lag_time: ifcopenshell.entity_instance.entity_instance
+        :type lag_time: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_recurrence_pattern.py

@@ -28,7 +28,7 @@ class Usecase:
         IfcRecurrencePattern, consult the IFC documentation.
 
         :param recurrence_pattern: The IfcRecurrencePattern entity you want to edit
-        :type recurrence_pattern: ifcopenshell.entity_instance.entity_instance
+        :type recurrence_pattern: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_sequence.py

@@ -28,7 +28,7 @@ class Usecase:
         IfcRelSequence, consult the IFC documentation.
 
         :param rel_sequence: The IfcRelSequence entity you want to edit
-        :type rel_sequence: ifcopenshell.entity_instance.entity_instance
+        :type rel_sequence: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task.py

@@ -25,7 +25,7 @@ class Usecase:
         IfcTask, consult the IFC documentation.
 
         :param task: The IfcTask entity you want to edit
-        :type task: ifcopenshell.entity_instance.entity_instance
+        :type task: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task_time.py

@@ -36,7 +36,7 @@ class Usecase:
         IfcTaskTime, consult the IFC documentation.
 
         :param task_time: The IfcTaskTime entity you want to edit
-        :type task_time: ifcopenshell.entity_instance.entity_instance
+        :type task_time: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_calendar.py

@@ -25,7 +25,7 @@ class Usecase:
         IfcWorkCalendar, consult the IFC documentation.
 
         :param work_calendar: The IfcWorkCalendar entity you want to edit
-        :type work_calendar: ifcopenshell.entity_instance.entity_instance
+        :type work_calendar: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_plan.py

@@ -27,7 +27,7 @@ class Usecase:
         IfcWorkPlan, consult the IFC documentation.
 
         :param work_plan: The IfcWorkPlan entity you want to edit
-        :type work_plan: ifcopenshell.entity_instance.entity_instance
+        :type work_plan: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_schedule.py

@@ -27,7 +27,7 @@ class Usecase:
         IfcWorkSchedule, consult the IFC documentation.
 
         :param work_schedule: The IfcWorkSchedule entity you want to edit
-        :type work_schedule: ifcopenshell.entity_instance.entity_instance
+        :type work_schedule: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_time.py

@@ -33,7 +33,7 @@ class Usecase:
         IfcWorkTime, consult the IFC documentation.
 
         :param work_time: The IfcWorkTime entity you want to edit
-        :type work_time: ifcopenshell.entity_instance.entity_instance
+        :type work_time: ifcopenshell.entity_instance
         :param attributes: a dictionary of attribute names and values.
         :type attributes: dict, optional
         :return: None

src/ifcopenshell-python/ifcopenshell/api/sequence/get_related_products.py

@@ -27,12 +27,12 @@ class Usecase:
         utility module.
 
         :param relating_product: One of the products already output by the task.
-        :type relating_product: ifcopenshell.entity_instance.entity_instance
+        :type relating_product: ifcopenshell.entity_instance
         :param related_object: The IfcTask that you want to get all the related
             products for.
-        :type related_object: ifcopenshell.entity_instance.entity_instance
+        :type related_object: ifcopenshell.entity_instance
         :return: A set of IfcProducts output by the IfcTask.
-        :rtype: set[ifcopenshell.entity_instance.entity_instance]
+        :rtype: set[ifcopenshell.entity_instance]
 
         Example:
 

src/ifcopenshell-python/ifcopenshell/api/sequence/recalculate_schedule.py

@@ -36,7 +36,7 @@ class Usecase:
         error.
 
         :param work_schedule: The IfcWorkSchedule to perform the calculation on.
-        :type work_schedule: ifcopenshell.entity_instance.entity_instance
+        :type work_schedule: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/remove_task.py

@@ -29,7 +29,7 @@ class Usecase:
         sequences or controls are also removed.
 
         :param task: The IfcTask to remove.
-        :type task: ifcopenshell.entity_instance.entity_instance
+        :type task: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/remove_time_period.py

@@ -24,7 +24,7 @@ class Usecase:
         """Removes a time period
 
         :param time_period: The IfcTimePeriod to remove.
-        :type time_period: ifcopenshell.entity_instance.entity_instance
+        :type time_period: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_calendar.py

@@ -28,7 +28,7 @@ class Usecase:
         calendar.
 
         :param work_calendar: The IfcWorkCalendar to remove
-        :type work_calendar: ifcopenshell.entity_instance.entity_instance
+        :type work_calendar: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_plan.py

@@ -28,7 +28,7 @@ class Usecase:
         removed.
 
         :param work_plan: The IfcWorkPlan to remove.
-        :type work_plan: ifcopenshell.entity_instance.entity_instance
+        :type work_plan: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_schedule.py

@@ -28,7 +28,7 @@ class Usecase:
         All tasks in the work schedule are also removed recursively.
 
         :param work_schedule: The IfcWorkSchedule to remove.
-        :type work_schedule: ifcopenshell.entity_instance.entity_instance
+        :type work_schedule: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_time.py

@@ -22,7 +22,7 @@ class Usecase:
         """Removes a work time
 
         :param work_time: The IfcWorkTime to remove.
-        :type work_time: ifcopenshell.entity_instance.entity_instance
+        :type work_time: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_lag_time.py

@@ -26,7 +26,7 @@ class Usecase:
         The schedule is cascaded afterwards.
 
         :param rel_sequence: The sequence to remove the lag time from.
-        :type rel_sequence: ifcopenshell.entity_instance.entity_instance
+        :type rel_sequence: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_process.py

@@ -28,9 +28,9 @@ class Usecase:
         See ifcopenshell.api.sequence.assign_process for details.
 
         :param relating_process: The IfcTask in the relationship.
-        :type relating_process: ifcopenshell.entity_instance.entity_instance
+        :type relating_process: ifcopenshell.entity_instance
         :param related_object: The related object.
-        :type related_object: ifcopenshell.entity_instance.entity_instance
+        :type related_object: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_product.py

@@ -28,9 +28,9 @@ class Usecase:
         See ifcopenshell.api.sequence.assign_product for details.
 
         :param relating_product: The IfcProduct in the relationship.
-        :type relating_product: ifcopenshell.entity_instance.entity_instance
+        :type relating_product: ifcopenshell.entity_instance
         :param related_object: The IfcTask in the relationship.
-        :type related_object: ifcopenshell.entity_instance.entity_instance
+        :type related_object: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_recurrence_pattern.py

@@ -25,7 +25,7 @@ class Usecase:
         you remove it, be sure to clean up after yourself.
 
         :param recurrence_pattern: The IfcRecurrencePattern to remove.
-        :type recurrence_pattern: ifcopenshell.entity_instance.entity_instance
+        :type recurrence_pattern: ifcopenshell.entity_instance
         :return: None
         :rtype: None
 

src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_sequence.py

@@ -26,9 +26,9 @@ class Usecase:
         """Removes a sequence relationship between tasks
 
         :param relating_process: The previous / predecessor task.
-        :type relating_process: ifcopenshell.entity_instance.entity_instance
+        :type relating_process: ifcopenshell.entity_instance
         :param related_process: The next / successor task.
-        :type related_process: ifcopenshell.entity_instance.entity_instance
+        :type related_process: ifcopenshell.entity_instance
         :return: None
         :rtype: None