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

generate_segments docstring #6

Closed
ajjackson opened this issue Jul 16, 2018 · 1 comment
Closed

generate_segments docstring #6

ajjackson opened this issue Jul 16, 2018 · 1 comment

Comments

@ajjackson
Copy link

The docstring for effmass.extrema.generate_segments seems to be outdated:

Generates a list of Segment objects.

Args:
    extrema_array (array(int)): A 2-dimensional array of size (number of extrema, 2). Each row corresponds to an extrema and contains [:attr:`~effmass.inputs.Data.bands` index, :attr:`~effmass.inputs.Data.kpoints` index]. See :func:`find_extrema_indices`.
    Settings (Settings): instance of the :class:`Settings` class.
    Data (Data): instance of the :class:`Data` class.
    truncate_dir_change (bool): If True, truncates eigenstates when there is a change in direction. If False, there is no truncation. Defaults to True.

Returns:
    list(Segments): A list of :class:`Segment` objects.

There is no extrema_array argument?

@lucydot
Copy link
Owner

lucydot commented Jul 23, 2018

Thanks @ajjackson I have updated the docstring here.

@lucydot lucydot closed this as completed Jul 23, 2018
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