Developer awareness of ListKeys about riak-dotnet-client HOT 7 CLOSED

My suggestion is to use the #warning pragma to display a compile time warning as well as XML documentation on the method.

from riak-dotnet-client.

I was hoping that there'd be some compile-time attribute I could just decorate it with, but it appears such a beast doesn't exist!

I'm not sure how you can get a warning to appear at the call site unless you use something like the ObsoleteAttribute. Easy to do inside CI because we wrote that, but not so much where someone writes client.ListKeys(...); in their own code.

Thoughts?

from riak-dotnet-client.

One option is to use PostSharp, but I'm not sure I'm keen on the idea of pulling an AOP utility in and increasing build times just for the sake of getting this coverage. We may just have to spit out text to the debugger and console and have docs in the XML tags.

from riak-dotnet-client.

Given the choice between AOP and using #if DEBUG to emit
Console.WriteLine("DANGER, WILL ROBINSON"), I'll fly to Brisbane to
convince you why #if DEBUG is less of a PITA. The ObsoleteAttribute doesn't
seem to be picked up correctly in MonoDevelop 3.0.4.7, either, so some kind
of forcible emit is going to be better. The ConditionalAttribute1 may
present a solid approach, too.

Jeremiah Peschka
Founder, Brent Ozar Unlimited

On Sat, Nov 10, 2012 at 2:14 PM, OJ Reeves [email protected] wrote:

One option is to use PostSharp, but I'm not sure I'm keen on the idea of
pulling an AOP utility in and increasing build times just for the sake of
getting this coverage. We may just have to spit out text to the debugger
and console and have docs in the XML tags.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/49#issuecomment-10260554.

from riak-dotnet-client.

Pack your bags and book your ticket, because #if DEBUG and ConditionalAttribute are compiled out in release mode builds. We ship release builds to Nuget.

Unless you're suggesting shipping debug builds via Nuget (which we won't be doing :)) we're going to have to look at something else. To be honest, I don't think conditional stuff is required. We output stuff to debug/console/whatever when the user calls those APIs no matter what. If devs keep those calls in after pushing to production then they're going to have bigger issues than stray output to a console.

Cheers man.

from riak-dotnet-client.

Damn you and your logic!

Let's just throw an Exception instead. Or trace/debug/console write on each
call.

Jeremiah Peschka, Managing Director, Brent Ozar PLF, LLC
Microsoft SQL Server MVP

On Nov 10, 2012, at 7:19 PM, OJ Reeves [email protected] wrote:

Pack your bags and book your ticket, because #if DEBUG and
ConditionalAttribute are compiled out in release mode builds. We ship
release builds to Nuget.

Unless you're suggesting shipping debug builds via Nuget (which we won't be
doing :)) we're going to have to look at something else. To be honest, I
don't think conditional stuff is required. We output stuff to
debug/console/whatever when the user calls those APIs no matter what. If
devs keep those calls in after pushing to production then they're going to
have bigger issues than stray output to a console.

Cheers man.

—
Reply to this email directly or view it on
GitHubhttps://github.com//issues/49#issuecomment-10262786.

from riak-dotnet-client.

Trace/Debug/Console write done on each call.

from riak-dotnet-client.