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

Update documentation #82

Merged
merged 14 commits into from
Feb 6, 2020
Merged

Update documentation #82

merged 14 commits into from
Feb 6, 2020

Conversation

benmwatson
Copy link
Member

Added significant documentation updates in README.md. Also added a diagram and updated the CHANGES.md file with last release.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Contributor

@nycdotnet nycdotnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice - left some feedback. I’m on mobile and will take another look tomorrow on my computer. Thank you!!

API.md Outdated Show resolved Hide resolved
API.md Outdated Show resolved Hide resolved
API.md Outdated Show resolved Hide resolved
API.md Outdated Show resolved Hide resolved
API.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@nycdotnet
Copy link
Contributor

imo the docs should explicitly state whether memory in the pooled buffers will be initialized or not - if not, calling GetBuffer() is a security risk due to the possibility the buffer will be bigger than the actual content.

@nycdotnet
Copy link
Contributor

This looks really great so far - thanks @benmwatson

benmwatson and others added 7 commits February 4, 2020 14:47
Co-Authored-By: Steve Ognibene <steve.ognibene@namely.com>
Co-Authored-By: Steve Ognibene <steve.ognibene@namely.com>
Co-Authored-By: Steve Ognibene <steve.ognibene@namely.com>
Co-Authored-By: Steve Ognibene <steve.ognibene@namely.com>
Co-Authored-By: Steve Ognibene <steve.ognibene@namely.com>
@benmwatson benmwatson merged commit a9c711c into master Feb 6, 2020
@benmwatson benmwatson deleted the docupdate branch February 6, 2020 16:52
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.

None yet

3 participants