Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.

Documentation is out of date #110

Closed
GotenXiao opened this issue Mar 16, 2016 · 4 comments
Closed

Documentation is out of date #110

GotenXiao opened this issue Mar 16, 2016 · 4 comments

Comments

@GotenXiao
Copy link

Congratulations on the release of 2.0!

Unfortunately, the documentation is still showing for the 1.x API (both on the GitHub README and on https://docs.getsentry.com/hosted/clients/csharp/). This caused some confusion when installing SharpRaven on a new project and being told that CaptureException was deprecated.

@asbjornu
Copy link
Contributor

@GotenXiao Thanks for pointing this out. I'll be sure to get to it some day, but if you have time to fix it, I would highly appreciate a pull request. You can edit the documentation directly on GitHub, no need to fork or clone locally. Just browse to the file you want to edit and click the edit pencil.

@c0bra
Copy link

c0bra commented May 11, 2016

👍

@c0bra
Copy link

c0bra commented Jul 20, 2016

@asbjornu Furthermore, while CaptureException(Exception) is deprecated it's still in use in the unit tests...: https://github.com/getsentry/raven-csharp/blob/64fa6b89737591323a4516afe318320b8d6cf53a/src/tests/SharpRaven.UnitTests/RavenClientTests/CaptureExceptionTests%20.cs

How are we SUPPOSED to capture an Exception? With CaptureException(new SentryEvent(Exception))?

I'd be happy to update the docs (or add an implicit operator) if you can give some direction.

@asbjornu
Copy link
Contributor

asbjornu commented Aug 8, 2016

@c0bra The unit tests will continue to execute methods that exist until they are removed, to ensure that they still work, although deprecated. The recommended way to capture exceptions now is with the Capture(SentryEvent) and CaptureAsync(SentryEvent) methods. All other Capture...() methods are [Obsolete] as you can see.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants