search

NetMQ / NetMQ.ReactiveExtensions

Effortlessly send messages anywhere on the network using Reactive Extensions (RX). Transport protocol is ZeroMQ.
Mozilla Public License 2.0
66 stars 14 forks source link

Capitalise NetMQ with a capital Q #44

Open liaochihung opened 7 years ago

liaochihung commented 7 years ago

Hi, I'm learning NetMQ & Rx, and this is a perfect project for me, thanks!

When I do the first copy & paste, found that 

var publisher = new PublisherNetMQ<int>("tcp://127.0.0.1:56001");
var subscriber = new SubscriberNetMQ<int>("tcp://127.0.0.1:56001");

could not be compiler, turns out it should be PublisherNetMq<int> and SubscriberNetMq<int>, and I found in the source there are some types end with 'NetMQ', and others 'NetMq'.

Will it be ok to keep in same convention ?

drewnoakes commented 7 years ago

Two letter acronyms are capitalised, according to Microsoft's framework design guidelines.

Ideally the API would be changed to maintain consistency with NetMQ and other framework types (such as IOException), however this would be a breaking change.

Applies to IPublisherNetMq, NetMqTransportShared, INetMqTransportShared, PublisherNetMq, SubscriberNetMq.

Others are fine, such as SubjectNetMQ.

If the API doesn't change, then the incorrect code in the README should at least be updated.

sharpe5 commented 7 years ago

I agree.

I'll fix it, and merge it into the current release candidate.

I think this is a good long term change to make - better now than later.

On Tue, Jan 10, 2017 at 9:33 PM, Drew Noakes notifications@github.com wrote:

Two letter acronyms are capitalised, according to Microsoft's framework design guidelines https://msdn.microsoft.com/en-us/library/ms229043(v=vs.110).aspx.

Ideally the API would be changed to maintain consistency with NetMQ and other framework types (such as IOException), however this would be a breaking change.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/NetMQ/NetMQ.ReactiveExtensions/issues/44#issuecomment-271704745, or mute the thread https://github.com/notifications/unsubscribe-auth/ABOypOZqzYRbts038YJychMTtXOtJ8TLks5rQ_lFgaJpZM4LfgkM .

sharpe5 commented 6 years ago

For now, I have made sure that readme.txt works out of the box with the NuGet release.

There is another release planned over the next month, in this release I will tidy up everything and upgrade it to the latest version of .NET Core.