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

Expand in-code documentation to ease potential contributions #81

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

kallewesterling
Copy link
Contributor

@kallewesterling kallewesterling commented Mar 24, 2023

  • Added some Black formatting to the files
  • Added inline comments to the code explaining what it does in each step, to ease potential contributions
  • Change name of extract_publications_text in the test files (from ept to full name extract_publications_text to make it easier to understand what's going on = see also Documentation of examples of running tests #75)

Contributes to #72.

This was a step in the direction for me to wrap my head around what the code does and where. I want to see if I can take a stab at contributing something for #30 next.

@kallewesterling
Copy link
Contributor Author

Don't know why black fails here since I'm formatting with black...?

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

Successfully merging this pull request may close these issues.

1 participant