standardize module docstring

This commit is contained in:
giovanni
2025-03-14 16:32:19 +01:00
committed by Nicola Demo
parent 0fcb78bc51
commit aea24d0bee
60 changed files with 61 additions and 122 deletions

View File

@@ -1,6 +1,4 @@
"""
Module for importing Conditions objects.
"""
"""Module for PINA Conditions classes."""
__all__ = [
"Condition",

View File

@@ -1,4 +1,4 @@
"""Condition module."""
"""Module for the Condition class."""
import warnings
from .data_condition import DataCondition

View File

@@ -1,6 +1,4 @@
"""
Module that defines the ConditionInterface class.
"""
"""Module for the Condition interface."""
from abc import ABCMeta
from torch_geometric.data import Data

View File

@@ -1,6 +1,4 @@
"""
DataCondition class
"""
"""Module for the DataCondition class."""
import torch
from torch_geometric.data import Data

View File

@@ -1,6 +1,4 @@
"""
DomainEquationCondition class definition.
"""
"""Module for the DomainEquationCondition class."""
from .condition_interface import ConditionInterface
from ..utils import check_consistency

View File

@@ -1,6 +1,4 @@
"""
Module to define InputEquationCondition class and its subclasses.
"""
"""Module for the InputEquationCondition class and its subclasses."""
from torch_geometric.data import Data
from .condition_interface import ConditionInterface