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

Simplify CI, fix cargo test, and fix docstrings #45

Merged
merged 8 commits into from
Aug 16, 2022

Conversation

simlay
Copy link
Contributor

@simlay simlay commented Aug 14, 2022

hey hey, saw some of the cool stuff with objc2 coming into this repo so I figured I'd throw in some help that's independent of the objc2 changes.

This PR updates:

  • CI to use cargo test which builds all the examples and their rust in docstrings.
  • Updates as many docstrings as I could to be "correct". I don't know if all the semantics of the examples make a ton of sense but I did my best.
  • Puts #[cfg(feature = "foo")] for examples that require feature foo (which are used in uikit and webview).

I figure this will enable us to have tests and prevent things like #32 are less likely to happen.

Copy link
Contributor

@madsmtm madsmtm left a comment

Choose a reason for hiding this comment

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

Wonderful, been wanting to do this as well!

examples/webview_custom_protocol.rs Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
src/listview/row/mod.rs Outdated Show resolved Hide resolved
@ryanmcgrath
Copy link
Owner

Huh, thought I responded to this via email.

Super appreciate this! It all looks good to me and I think just needs a formatting pass to satisfy the PR checks here. Happy to merge after that. :)

@simlay
Copy link
Contributor Author

simlay commented Aug 16, 2022

It all looks good to me and I think just needs a formatting pass to satisfy the PR checks here.

hmm. When I run cargo fmt locally, it changes a lot. This could be from the recent rust release or maybe there's something not obvious?

@ryanmcgrath ryanmcgrath merged commit ce0a8e5 into ryanmcgrath:trunk Aug 16, 2022
@ryanmcgrath
Copy link
Owner

shrug

Beats me - but it passes it now and that's good enough for me. I might go ahead and cut a new point release for this just so anyone looking at docs has your work here visible - and then I think 0.4 can be a target for objc2 PRs.

Seriously appreciate this PR!

@simlay simlay deleted the fix-cargo-test branch August 17, 2022 16:42
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.

3 participants