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

Capitalise NetMQ with a capital Q #44

Open
liaochihung opened this issue Jan 10, 2017 · 3 comments
Open

Capitalise NetMQ with a capital Q #44

liaochihung opened this issue Jan 10, 2017 · 3 comments

Comments

@liaochihung
Copy link

liaochihung commented Jan 10, 2017

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
Copy link
Member

drewnoakes commented Jan 10, 2017

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.

@drewnoakes drewnoakes changed the title Naming convention Capitalise NetMQ with a capital Q Jan 10, 2017
@sharpe5
Copy link
Member

sharpe5 commented Jan 10, 2017 via email

@sharpe5
Copy link
Member

sharpe5 commented Dec 14, 2017

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.

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

No branches or pull requests

3 participants