Skip to content

Capitalise NetMQ with a capital Q #44

Description

@liaochihung

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 ?

Activity

  1. drewnoakes commented on Jan 10, 2017

    @drewnoakes
    Member

    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.

  2. changed the title [-]Naming convention[/-] [+]Capitalise NetMQ with a capital Q[/+] on Jan 10, 2017
  3. sharpe5 commented on Jan 10, 2017

    @sharpe5
    Member
  4. sharpe5 commented on Dec 14, 2017

    @sharpe5
    Member

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions