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

feat(demangle): Improve docs for symbolic-demangle #241

Merged
merged 3 commits into from
Jun 2, 2020

Conversation

jan-auer
Copy link
Member

Updates docs of symbolic-demangle, as they were out of date and sometimes incomplete. Particularly, this includes:

  • More examples for the demangle functions
  • Correct description of flags and return types
  • A README generated from the crate docs using cargo-readme

@jan-auer jan-auer requested a review from a team May 31, 2020 18:17
@jan-auer jan-auer self-assigned this May 31, 2020
@jan-auer jan-auer force-pushed the feat/demangle-docs branch 2 times, most recently from 6575382 to 4087730 Compare May 31, 2020 18:18
@@ -25,5 +26,11 @@ msvc-demangler = "0.8.0"
rustc-demangle = "0.1.16"
symbolic-common = { version = "7.3.3", path = "../common" }

[dev-dependencies]
symbolic = { path = "..", features = ["demangle"] }
Copy link
Member

Choose a reason for hiding this comment

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

Just a heads up… I know this pattern is super useful, as I have also used it for the rust SDK, but you are not able to properly publish with this: rust-lang/cargo#4242 😭

Copy link
Member Author

Choose a reason for hiding this comment

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

Alright, let me revert this then. Too bad, it made the examples much nicer.

Copy link
Member

Choose a reason for hiding this comment

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

Yes it definitely does! I’m also not yet sure what I should do about this for the SDK, since I depend on sentry::init and sentry::test a lot in the doctests 😭

Copy link
Member Author

Choose a reason for hiding this comment

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

For the Sentry SDK, doing something similar to futures would probably be worth it. In symbolic, I guess people can extrapolate how to rewrite the imports until there's a proper solution for this in cargo.

demangle/src/lib.rs Show resolved Hide resolved
demangle/src/lib.rs Outdated Show resolved Hide resolved
@jan-auer jan-auer merged commit 82f7787 into master Jun 2, 2020
@jan-auer jan-auer deleted the feat/demangle-docs branch June 2, 2020 11:13
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.

2 participants