Feature docs #18
Merged
Feature docs #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
See attached zip file for the browseable version of the docs. |
immesys
requested changes
Jan 14, 2019
|
@immesys I've implemented all of your comments although I couldnt fix the odd github rendering of the subheading. I think it might have to do with the dashes used a few lines below in the table. It does not appear to affect HTML rendering though so I suggest we ignore it for now. Sorry but I resolved the request changes as I did them not realizing that I would be removing the breadcrumbs for you to review. Finally, I just asked for permissions to integrate with Travis. It seems there were multiple hurdles for me to get this done. Once it's complete I'll have one more commit although I can do that in a separate, tiny PR instead if you prefer. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is primarily to add comments and update documentation however there are a few minor bug fixes included that were uncovered during documentation.
This is a rather large amount of docs however it should be pretty straightforward to read. I'll also attach a zip of the HTML that it builds if that helps the review process.
I'd like to call this done for now pending comments, requested changes, etc. The docs are another case where it can be an unlimited time sink if you let it but I think it's of high enough quality that we can put it out as it stands as long as nothing is incorrect.
@immesys please pay particular attention to the docs surrounding windowing as I feel less confident about some of my explanations.
Once we are both happy enough to merge to the
developbranch then it will be automatically built and available online at https://btrdb.readthedocs.io/en/develop/ but will not replace the official version at https://btrdb.readthedocs.io/en/latest/.