search

gallantlab / cottoncandy

sugar for s3
http://gallantlab.github.io/cottoncandy/
BSD 2-Clause "Simplified" License
33 stars 17 forks source link

Sphinx #74

Closed cchen23 closed 4 years ago

cchen23 commented 4 years ago

I adapted the gendoc/ files from tikreg to use with cottoncandy, and included the generated doc files. (The index of the documetation is in cottoncandy/docs/index.html.)

This api reference includes a bunch of modules that are not included in the current cottoncandy documentation (such as Encryption, backend, and options), but I can take those out if needed.

anwarnunez commented 4 years ago

great! seems a lot of these changes are caused by the change from single to double quotes. i imagine this is due to your editor settings. can you fix that? re extra modules: yes, please don't include those. thanks!

cchen23 commented 4 years ago

seems a lot of these changes are caused by the change from single to double quotes. i imagine this is due to your editor settings. can you fix that? Oh, I changed the docstrings with single quotes to use double quotes (because it seemed like most of the docstrings had single quotes). But I can change the ones that had single quotes, back to having single quotes!

cchen23 commented 4 years ago

re extra modules: yes, please don't include those. Okay, I'll update it to just include the browser, utils, and interfaces modules!

anwarnunez commented 4 years ago

re quotes: I tend to prefer single quotes. if you want to make a separate pull request to standardize quotes, feel free. i don't know of a strong reason to prefer double quotes over single quotes, but if you have one i'd be happy to comply. on the other hand, if it's a pain to change things back, don't worry about it. just let me know

cchen23 commented 4 years ago

re quotes: I tend to prefer single quotes. if you want to make a separate pull request to standardize quotes, feel free. i don't know of a strong reason to prefer double quotes over single quotes, but if you have one i'd be happy to comply. on the other hand, if it's a pain to change things back, don't worry about it. just let me know

Oh, I see. I don't have a particular preference personally, just noticed that some were single and some were double quotes. I've updated the PR to remove the commit that changes from single to double quotes.

cchen23 commented 4 years ago

I've also updated the PR to only include the browser, interfaces, and utils modules (and __init__.py.)

anwarnunez commented 4 years ago

ok, i will merge. because the pull request is from a fork, the CI tests haven't been ran (unfortunately we can't get around this). once I merge they will run :crossed_fingers:

marklescroart commented 4 years ago

Can you possibly re-target the PR to a branch on the main repo? That way you could merge there, then eventually merge to master.

On Mar 30, 2020, at 2:06 PM, Anwar Nunez-Elizalde notifications@github.com wrote:

Merged #74 https://github.com/gallantlab/cottoncandy/pull/74 into master.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/gallantlab/cottoncandy/pull/74#event-3180496037, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABJ6LQ4SXI5ZWD7NPVAXK3TRKECVNANCNFSM4LWBUBHQ.

anwarnunez commented 4 years ago

This was already merged.