Skip to content
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

Not all calculators have auto doc strings in Jupyter #483

Open
SamTov opened this issue Jan 28, 2022 · 1 comment
Open

Not all calculators have auto doc strings in Jupyter #483

SamTov opened this issue Jan 28, 2022 · 1 comment

Comments

@SamTov
Copy link
Member

SamTov commented Jan 28, 2022

I have noticed that while pushing shift tab in Jupyter that some of the calculators such as coordination numbers, Einstein diffusion and very likely more do not have the doc stings shown and rather are just a property. This is not the case for calculators such as RDFs but it should be uniform across the board.

@PythonFZ
Copy link
Member

They should all behave the same

@property
def AngularDistributionFunction(self) -> AngularDistributionFunction:
return self.exp_wrapper(AngularDistributionFunction)(**self.kwargs)
@property
def CoordinationNumbers(self) -> CoordinationNumbers:
return self.exp_wrapper(CoordinationNumbers)(**self.kwargs)
@property
def EinsteinDiffusionCoefficients(self) -> EinsteinDiffusionCoefficients:
return self.exp_wrapper(EinsteinDiffusionCoefficients)(**self.kwargs)
@property
def EinsteinDistinctDiffusionCoefficients(
self,
) -> EinsteinDistinctDiffusionCoefficients:
return self.exp_wrapper(EinsteinDistinctDiffusionCoefficients)(**self.kwargs)
@property
def EinsteinHelfandIonicConductivity(self) -> EinsteinHelfandIonicConductivity:
return self.exp_wrapper(EinsteinHelfandIonicConductivity)(**self.kwargs)
@property
def EinsteinHelfandThermalKinaci(self) -> EinsteinHelfandThermalKinaci:
return self.exp_wrapper(EinsteinHelfandThermalKinaci)(**self.kwargs)
@property
def GreenKuboViscosityFlux(self) -> GreenKuboViscosityFlux:
return self.exp_wrapper(GreenKuboViscosityFlux)(**self.kwargs)
@property
def GreenKuboDistinctDiffusionCoefficients(
self,
) -> GreenKuboDistinctDiffusionCoefficients:
return self.exp_wrapper(GreenKuboDistinctDiffusionCoefficients)(**self.kwargs)
@property
def GreenKuboIonicConductivity(self) -> GreenKuboIonicConductivity:
return self.exp_wrapper(GreenKuboIonicConductivity)(**self.kwargs)
@property
def GreenKuboDiffusionCoefficients(self) -> GreenKuboDiffusionCoefficients:
return self.exp_wrapper(GreenKuboDiffusionCoefficients)(**self.kwargs)
@property
def GreenKuboThermalConductivity(self) -> GreenKuboThermalConductivity:
return self.exp_wrapper(GreenKuboThermalConductivity)(**self.kwargs)
@property
def GreenKuboViscosity(self) -> GreenKuboViscosity:
return self.exp_wrapper(GreenKuboViscosity)(**self.kwargs)
@property
def KirkwoodBuffIntegral(self) -> KirkwoodBuffIntegral:
return self.exp_wrapper(KirkwoodBuffIntegral)(**self.kwargs)
@property
def NernstEinsteinIonicConductivity(self) -> NernstEinsteinIonicConductivity:
return self.exp_wrapper(NernstEinsteinIonicConductivity)(**self.kwargs)
@property
def PotentialOfMeanForce(self) -> PotentialOfMeanForce:
return self.exp_wrapper(PotentialOfMeanForce)(**self.kwargs)
@property
def RadialDistributionFunction(self) -> RadialDistributionFunction:
return self.exp_wrapper(RadialDistributionFunction)(**self.kwargs)
@property
def StructureFactor(self) -> StructureFactor:
return self.exp_wrapper(StructureFactor)(**self.kwargs)
@property
def EinsteinHelfandThermalConductivity(self) -> EinsteinHelfandThermalConductivity:
return self.exp_wrapper(EinsteinHelfandThermalConductivity)(**self.kwargs)

but I do think that they should be changed to e.g. -> Type[CoordinationNumbers] actually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants