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

Some doc fixups #104

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

gadomski
Copy link

@gadomski gadomski commented Nov 6, 2024

Description

  • I moved the doc files up to the top level and linked to them from docs — this lets the links work from https://github.com/worldbank/blackmarblepy/blob/main/README.md as well as the docs website.
  • Fixed a small typo in the README intro (extra ,)
  • Removed the "no display" tag from the example notebook for the imports block — to me, it is very confusing to read a notebook and not know where a function came from
  • Ignore docs/api since those are autogenerated

Motivation

Type of change

  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

These arose while doing my pyOpenSci review:
pyOpenSci/software-submission#207 (comment)
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