Skip to content

Expand in-code documentation to ease potential contributions#81

Open
kallewesterling wants to merge 2 commits intomainfrom
kallewesterling/issue72
Open

Expand in-code documentation to ease potential contributions#81
kallewesterling wants to merge 2 commits intomainfrom
kallewesterling/issue72

Conversation

@kallewesterling
Copy link
Copy Markdown
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
Copy Markdown
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