Comments (2)
Personally I would vote for:
Line Breaks
Each sentence on its own line. This allows for pull request reviews to make suggestions to individual sentences which is a natural unit of language without changing the line breaks for unrelated lines.
This is a full sentence.
This is another full sentence, which is much longer but still continues to be on the same line.
Reviewing a pull request with this style seems much easier in my opinion.
Very long lines can still be soft-wrapped by an editor if the reader wishes.
Referencing external RFCs
I personally like the regular markdown link syntax. The linked RFC is still included in the bibliography and it reads more naturally to me. It is much easier to link RFC0000 Section x.y than to read a full URL and linking only to the bibliography is annoying for the user who clicks the link to go to the section referenced.
Referencing fields
I like to use the inline code with markdown link like trace-id
, but this is probably the most inconsistent aspect of our specification.
from trace-context.
Created a PR for a style guide with the above suggestions https://github.com/w3c/distributed-tracing-wg/pull/49/files
from trace-context.
Related Issues (20)
- Adopt either span-id or parent-id for section headings HOT 4
- When headers should be propagated in browsers should be made more clear HOT 2
- Change the defining document for HTTP from RFC7230 to RFC9110 HOT 2
- Update tests to test Trace Context level 2 by default
- Incorporate Level 2 changes (random trace id flag) into traceresponse header in Level 3
- Add more normative text for flags processing in traceresponse
- Level 3 spec: Update privacy section to include information about traceresponse headers.
- Random part of trace ID should be uniformly distributed HOT 3
- Autopublishing level2/Level3 specs need to work with multiple markdown files HOT 2
- Document handling of tracestate duplicate keys HOT 6
- Does this specification define a way to handle retries? HOT 4
- Proposal: Add a "propagation-only-parent" flag to be set to true if parents is a no-tracing service HOT 6
- Proposal: Allow common base64 encoding in tracestate values HOT 5
- Should tracing headers be included in 304 Not Modified responses? HOT 14
- Revisit header name -- Server-Timing vs. traceresponse HOT 9
- Server-timing names HOT 6
- Remove all markdown includes
- Can Traceresponse enable parent-child relationship between browser and server spans?
- Trace Context Extensibility HOT 7
- request for clarification re size of parent-id HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from trace-context.