Please clarify code documentation to indicate methods which should not be used for new projects

optimizely / csharp-sdk

.NET based C# SDK for Optimizely Feature Experimentation and Optimizely Full Stack (legacy)

https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk

Apache License 2.0

19 stars 20 forks source link

Please clarify code documentation to indicate methods which should not be used for new projects #290

Closed mhenry-cb closed 2 years ago

mhenry-cb commented 2 years ago

Please clarify XML doc comments and/or add Obsolete attributes to indicate methods which should not be used for new projects.

For example, Optimizely.Activate should not be used with a "Flags project which uses the new SDK".

The following docs appear to need updating as well:

README
docs under docs/readme-sync/sdk-reference-guides/csharp-sdk

dustin-sier commented 2 years ago

Thanks for the information, we'll be discussing our options for documenting this.

dustin-sier commented 2 years ago

We've added a set of stories to our backlog to address this across SDKs. We won't be using the Obsolete attribute because these code paths are still supported, but just not with the new project format.