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

[DOC] Misc small fixes for code documentation & docsite #30

Merged
merged 3 commits into from
Apr 24, 2020
Merged

Conversation

TomDonoghue
Copy link
Member

@TomDonoghue TomDonoghue commented Apr 24, 2020

This PR includes small tweaks for code, documentation, and the docsite:

  • a sweep through of in-code documentation
    • in particular, add docstrings to property attributes, so these get rendered on the docsite
  • a sweep through of the documentation site
  • a sweep through of code linting
    • biggest updates are to remove 'dangerous' defaults of empty collection items, and replace to have optional parameters default to None, and then deal with the None values

@ryanhammonds : this started as some small follow ups from your PR that I didn't want to start making nitpicky comments about. In terms of review, it would be great if you can throw a quick check through the file diffs, keeping an eye out for any typos, weirdnesses or quirks, and also just check you can pull this branch and build the docsite and nothing goes haywire, but otherwise this doesn't need an extensive review (also no rush on it).

@lisc-tools lisc-tools deleted a comment from codecov-io Apr 24, 2020
Copy link
Contributor

@ryanhammonds ryanhammonds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@TomDonoghue TomDonoghue merged commit f25a1be into master Apr 24, 2020
@TomDonoghue TomDonoghue deleted the doc branch January 26, 2021 19:17
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.

2 participants