Skip to content

Improve documentation a bit#135

Merged
pwildenhain merged 1 commit into
redcap-tools:masterfrom
njvack:doc_edits
Mar 23, 2021
Merged

Improve documentation a bit#135
pwildenhain merged 1 commit into
redcap-tools:masterfrom
njvack:doc_edits

Conversation

@njvack
Copy link
Copy Markdown
Contributor

@njvack njvack commented Nov 5, 2020

Change references to original github URL to the one in the redcap-tools
organization.

Also tighten up the Installation section of index.rst -- we don't need
to care about the requests dependency, really. Mention the pandas
installation option.

Still TODO: Change the maintainer entry in setup.py.

Change references to original github URL to the one in the redcap-tools
organization.

Also tighten up the Installation section of index.rst -- we don't need
to care about the requests dependency, really. Mention the pandas
installation option.
@njvack
Copy link
Copy Markdown
Contributor Author

njvack commented Nov 5, 2020

The other thing that might be worth mentioning in the docs (or just in the README) is that this project is not affiliated with the official Project REDCap.

@pwildenhain
Copy link
Copy Markdown
Collaborator

Ah Darn, I also added a small contributing section to the README in #132 -- should that actually live in contributing.rst?

👍 For adding the maintainers list
👍 For mentioning this project is not offficial :neckbeard:

@njvack
Copy link
Copy Markdown
Contributor Author

njvack commented Nov 10, 2020

I'd say that a small contributing section in readme is good (probably link to the one on readthedocs) -- I don't know that I'd think to check the docs for it otherwise.

@pwildenhain
Copy link
Copy Markdown
Collaborator

That makes sense, would you also be able to add that in this PR? Link out the the contributing.rst from the README? And then we'll likely need to update contributing.rst at some point haha

@njvack
Copy link
Copy Markdown
Contributor Author

njvack commented Nov 10, 2020

Yeah, that should be fine, it'll be a day or two, though; I'm on a lil vacation here.

@pwildenhain
Copy link
Copy Markdown
Collaborator

@njvack You've done good work here already, I'm just going to merge what you have. Feel free to submit another PR though if there is more you'd like to add.

@pwildenhain pwildenhain merged commit fa5c446 into redcap-tools:master Mar 23, 2021
@njvack
Copy link
Copy Markdown
Contributor Author

njvack commented Mar 23, 2021

Aww snap, thank you! I 100% forgot I had this outstanding :/

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