Skip to content

Improve documentation #2

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.

Sign up for GitHub

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

Jump to bottom
Open
madsmtm wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Improve documentation #2

madsmtm wants to merge 5 commits into from

Conversation

@madsmtm
Copy link

@madsmtm madsmtm commented Jun 1, 2021 •
edited
Loading

  • Add #![warn(missing_docs)]
  • Link to types from lib.rs
  • Document all enum variants of Encoding
  • Add example implementation of Encode for NSString`
  • Move documentation link to docs.rs
  • Add header to README.md
  • Add badges to README.md
  • Small fixes

I sneaked an cargo fmt in here as well 😉

madsmtm added 5 commits June 1, 2021 12:29
@madsmtm
Run cargo fmt
1b23565
@madsmtm
Improve documentation
b88cd5e 
- Add #![warn(missing_docs)]
- Link to types from lib.rs
- Document all enum variants of `Encoding`
- Small fixes
@madsmtm
Add NSString example
a968191 
Important to showcase how to implement Encode for Objective-C objects that we don't know the internal representation of.
@madsmtm
Move documentation to docs.rs
a436674
@madsmtm
Add header and badges to README
3f26bf6
@madsmtm madsmtm force-pushed the improve-documentation branch from ee80b70 to 3f26bf6 Compare June 1, 2021 12:59
This was referenced Sep 1, 2021
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@madsmtm