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

Remove the errant backtick in the README.rst #139

Closed
rmarkello opened this issue Mar 12, 2020 · 1 comment
Closed

Remove the errant backtick in the README.rst #139

rmarkello opened this issue Mar 12, 2020 · 1 comment
Labels
documentation Relates to updating documentation good first issue Good for newcomers

Comments

@rmarkello
Copy link
Owner

rmarkello commented Mar 12, 2020

The issue

There is an unnecessary backtick (`) at the beginning L48 of the abagen/info.py file that is showing up in the README and should be removed:

abagen/abagen/info.py

Lines 47 to 50 in c64d948

Arnatkevičiūte et al., 2019 provided a thorough treatment of this in a `recent
`manuscript <https://www.sciencedirect.com/science/article/pii/
S1053811919300114>`__, demonstrating how the techniques and code used to
prepare the raw AHBA data have varied widely across published reports.

Proposed solution

We try not to edit the README.rst file directly, so this can be accomplished by following these steps:

  1. Delete the extra backtick (the one immediately preceding the word 'manuscript') in the abagen/info.py file:
- `manuscript <https://www.sciencedirect.com/science/article/pii/ 
+ manuscript <https://www.sciencedirect.com/science/article/pii/ 
  1. Regenerate the README.rst file by running bash tools/update_readme.py from the root of the abagen directory.
  2. Commit the changes to both files and open a PR!
@rmarkello rmarkello added good first issue Good for newcomers documentation Relates to updating documentation labels Mar 12, 2020
@4lovi4
Copy link
Contributor

4lovi4 commented Oct 19, 2020

Hi @rmarkello may I take a shot to resolve the issue?

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
Projects
None yet
Development

No branches or pull requests

2 participants