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

Shorten some subclause stable names #44

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Shorten some subclause stable names #44

wants to merge 8 commits into from

Conversation

jwakely
Copy link
Member

@jwakely jwakely commented Oct 5, 2016

Some clause names are very long, and cause clause headings to wrap onto two lines. This reduces some of the worst, although there are still:

[buffer.stream.reqmts.syncwritestream]
[buffer.stream.reqmts.asyncwritestream]
[buffer.stream.reqmts.completioncondition]

And these which don't cause any wrapping problems:
[socket.reqmts.endpointsequence]
[socket.reqmts.acceptableprotocol]
[socket.reqmts.gettablesocketoption]
[socket.reqmts.settablesocketoption]
[socket.reqmts.iocontrolcommand]
[socket.reqmts.connectcondition]

Other abbreviations we could consider are socket -> sock, option -> opt, internet -> inet

@jwakely
Copy link
Member Author

jwakely commented Oct 5, 2016

@chriskohlhoff any opinion on this?

@chriskohlhoff
Copy link
Contributor

Some ideas...

buffer.stream.* -> buf.stream.*

*.completioncondition -> *.compl.cond

option -> opt, e.g. socket.reqmts.gettablesocketoption -> socket.reqmts.opt.gettable

protocol -> proto

Since the word stream is already in the section, can it be dropped from the individual requirement part? E.g.:

buffer.stream.reqmts.syncwritesteram -> buffer.stream.reqmts.syncwrite

@jwakely
Copy link
Member Author

jwakely commented Oct 7, 2016

socket.reqmts.gettablesocketoption -> socket.reqmts.opt.gettable

I like that.

Since the word stream is already in the section, can it be dropped from the individual requirement part?

Yes, I had the same thought yesterday.

I think I'll shorten when it's causing formatting problems, or the name duplicates something like "socket" or "stream" and leave the others.

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants