Skip to content

Commit 3019cf0

Browse files
lwasserNickleDave
andcommitted
Fix: Review edits to doc section from @NickleDave
Co-authored-by: David Nicholson <[email protected]> Update documentation/package-documentation-sphinx.md Co-authored-by: David Nicholson <[email protected]>
1 parent e19f021 commit 3019cf0

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

documentation/package-documentation-sphinx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Examples of documentation that we love:
1111
* [Here is our documentation if you want to see a myST example of a landing page.](https://github.com/pyOpenSci/python-package-guide/blob/main/index.md)
1212
```
1313

14-
In addition to a well designed [README FILE](readme-file-best-practices), and a
14+
In addition to a well designed [README FILE](readme-file-best-practices), and a
1515
[contributing file](contributing-file),
1616
there are several core components of Python package documentation,
1717
including:

documentation/readme-file-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ It is also used to measure:
1818
name: directive-fig
1919
width: 80%
2020
---
21-
Your GitHub repository landing page highlights the README.md file. Here you can see the README.md file for [Pandera](https://github.com/unionai-oss/pandera), a pyOpenSci vetted package. *(screen shot taken Nov 23 2022)*
21+
Your GitHub repository landing page highlights the README.md file. Here you can see the README.md file for the pyOpenSci package [Pandera](https://github.com/unionai-oss/pandera). *(screen shot taken Nov 23 2022)*
2222
```
2323

2424
Thus, it is important that you spend some time up front creating a high quality

0 commit comments

Comments
 (0)