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

Extra space in abagen.correct.remove_distance doc-string #80

Closed
rmarkello opened this issue Aug 16, 2019 · 1 comment
Closed

Extra space in abagen.correct.remove_distance doc-string #80

rmarkello opened this issue Aug 16, 2019 · 1 comment
Labels
documentation Relates to updating documentation good first issue Good for newcomers refactor Not an enhancement, but not a bug

Comments

@rmarkello
Copy link
Owner

The issue

Introduced by #76. Due to an errant space in the doc-string of abagen.correct.remove_distance() the rendered Sphinx documentation for the function looks like this:

bad_docstring

That's...not right. There shouldn't be the line split and the weird highlighting on the first part of the description.

Proposed solution

Removing the extra space on L47 of abagen.correct right before "between" should do the trick! That is, the doc-string should be changed as follows:

     residualized : (R, R) numpy.ndarray
         Provided `coexpression` data residualized against spatial distance
-         between region pairs
+        between region pairs
@rmarkello rmarkello added good first issue Good for newcomers documentation Relates to updating documentation refactor Not an enhancement, but not a bug labels Aug 16, 2019
@4lovi4
Copy link
Contributor

4lovi4 commented Oct 19, 2020

Hello @rmarkello . Just tried to make the change as proposed. PR is on the way. Please assign to me.
issue_80

rmarkello added a commit that referenced this issue Oct 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to updating documentation good first issue Good for newcomers refactor Not an enhancement, but not a bug
Projects
None yet
Development

No branches or pull requests

2 participants