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

No documentation on how to access the 2D surface returned by MembThickness #143

Open
p-j-smith opened this issue Feb 2, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@p-j-smith
Copy link
Owner

Which section of the documentation needs improving?
Please provide a link (if it is a specific page).

https://lipyphilic.readthedocs.io/en/latest/reference/analysis/memb_thickness.html#lipyphilic.analysis.memb_thickness.MembThickness

What can be improved about this section
Is it incomplete, incorrect or difficult to understand?

As pointed out int #142, there is no documentation on how to access the 2D surface returned by MembThickness if return_surface is true.

How to improve this section
Do you have any specific suggestions we could take to improve the documentation?

The surface is stored in the attribute memb_thickness_grid:

if self._return_surface:
self.memb_thickness_grid = np.full(
(self.n_frames, self.n_bins, self.n_bins),
fill_value=np.NaN,
)

This should be added to the description of the return_surface argument.

@p-j-smith p-j-smith added the documentation Improvements or additions to documentation label Feb 2, 2024
@p-j-smith p-j-smith self-assigned this Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant