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.

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

docs: added rustdoc icons #7253

Merged
merged 9 commits into from
Jun 20, 2023
Merged

docs: added rustdoc icons #7253

merged 9 commits into from
Jun 20, 2023

Conversation

simonhyll
Copy link
Contributor

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Docs
  • New Binding issue #___
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change?

  • Yes, and the changes were approved in issue #___
  • No

Checklist

  • When resolving issues, they are referenced in the PR's title (e.g fix: remove a typo, closes #___, #___)
  • A change file is added if any packages will require a version bump due to this PR per the instructions in the readme.
  • I have added a convincing reason for adding this feature, if necessary

Other information

Gives the generated rust documentation a little bit of a facelift by adding icons to it.
My compelling reason is that giving the documentation a splash of color makes it more fun to read and makes it look more professional.

@simonhyll simonhyll requested a review from a team as a code owner June 18, 2023 16:12
wusyong
wusyong previously approved these changes Jun 18, 2023
View reviewed changes
@lucasfernog
Copy link
Member

Nice! Should we do this for all crates? @simonhyll

@lucasfernog
Copy link
Member

We should also do this for all plugins. We have banners for most of them.

@lucasfernog
Copy link
Member

I've opened tauri-apps/plugins-workspace#442 in case we want to use them for docs.rs too.

@simonhyll
Copy link
Contributor Author

There we go @lucasfernog 😃

lucasfernog
lucasfernog requested changes Jun 19, 2023
View reviewed changes
tooling/webdriver/src/main.rs Outdated Show resolved Hide resolved
tooling/cli/src/lib.rs Outdated Show resolved Hide resolved
tooling/bench/src/run_benchmark.rs Outdated Show resolved Hide resolved
tooling/bench/src/build_benchmark_jsons.rs Outdated Show resolved Hide resolved
core/tauri-utils/src/lib.rs Outdated Show resolved Hide resolved
core/tauri-macros/src/lib.rs Outdated Show resolved Hide resolved
core/tauri-build/src/lib.rs Show resolved Hide resolved
simonhyll and others added 5 commits June 19, 2023 15:02
@simonhyll @lucasfernog
Update core/tauri-macros/src/lib.rs
bb7d860 
Co-authored-by: Lucas Fernandes Nogueira <[email protected]>
@simonhyll @lucasfernog
Update core/tauri-utils/src/lib.rs
a3e1c54 
Co-authored-by: Lucas Fernandes Nogueira <[email protected]>
@simonhyll @lucasfernog
Update tooling/bench/src/build_benchmark_jsons.rs
0cc3754 
Co-authored-by: Lucas Fernandes Nogueira <[email protected]>
@simonhyll @lucasfernog
Update tooling/cli/src/lib.rs
0a1af52 
Co-authored-by: Lucas Fernandes Nogueira <[email protected]>
@simonhyll @lucasfernog
Update tooling/bench/src/run_benchmark.rs
2e0002a 
Co-authored-by: Lucas Fernandes Nogueira <[email protected]>
@simonhyll
Copy link
Contributor Author

Also did the same thing for the plugins now 🙂 tauri-apps/plugins-workspace#443

@lucasfernog
Copy link
Member

Just have to fix formatting now it seems.

@simonhyll
Copy link
Contributor Author

simonhyll commented Jun 19, 2023 •
edited
Loading

Just have to fix formatting now it seems.

@lucasfernog The 3 formatting tests that fail are because of normalize_doc_attributes = true in rustfmt.toml which is only available in nightly. Not much I can do about that, either the CI needs to be updated to use the nightly toolchain or that option needs to be disabled. Or the CI has to be set to not fail because of warnings.

@lucasfernog
Copy link
Member

Something must've been wrong with the file format, probably because of Windows.

@simonhyll simonhyll changed the title feat: added rustdoc icons docs: added rustdoc icons Jun 19, 2023
@lucasfernog lucasfernog merged commit c34e37b into tauri-apps:dev Jun 20, 2023
@simonhyll simonhyll deleted the feat/rustdoc-icons branch June 20, 2023 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amrbashir amrbashir amrbashir left review comments

@lucasfernog lucasfernog lucasfernog approved these changes

@wusyong wusyong wusyong left review comments

Assignees
No one assigned
Labels
None yet
Projects
Roadmap
Status: 🔎 In audit
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@simonhyll @lucasfernog @wusyong @amrbashir