Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Use consistent format for paths in documentation.

See original GitHub issue

Currently there are several file paths in command line promts in the documentation used in in different formats.It would be helpful if this is unified.

Found variants:

~/hono$
~hono/deploy$
$ /hono/cli/target$
~/hono/services/device-registry $
No file path given, even if the command depends on it

Issue Analytics

State:
Created 5 years ago
Comments:10 (10 by maintainers)

Top GitHub Comments

2reactions

b-abelcommented, Mar 14, 2019

I would think more like:

mosquitto_pub -p 8883 -t telemetry -m '{"temp": 5}' --cert demo-certs/certs/device-4711-cert.pem --key device-4711-key.pem --cafile demo-certs/certs/trusted-certs.pem

Maybe that wasn’t a good example either 😃 But still, the base directory is be completely implicit with this and the reader needs to figure out the context before pasting the command into the shell. Do you mind adding (initial) path information where necessary in a comment? Like e.g.:

# run from: hono/example/
mvn exec:java -Dexec.mainClass=org.eclipse.hono.vertx.example.HonoExampleApplication

This is short, doesn’t disturb copy & paste and IMHO ticks the “Don’t make me think” box.

0reactions

sophokles73commented, Mar 25, 2019

@b-abel can we (you) close this?

Top Results From Across the Web

Make a consistent drive letter or path to a removable drive

Migrating drive letters is a problem when programs remember fixed drive letters in paths to documents. All Office programs do that in their...

Formatting your documentation content - Apple Developer

To ensure consistent structure and styling, use DocC's documentation ... In the example above, both symbol paths are identical, regardless of text case....

Connecting to Volumes With Consistent Device Paths

Oracle Cloud Infrastructure supports consistent device paths for block volumes that are attached to compatible Linux-based instances.

Formatting text in instructions - Microsoft Style Guide

Element Convention Example Command‑line commands Bold. All lowercase. copy Database names Bold. The capitalization of database names varies. WingtipToys... Device and port names All uppercase. USB...

File naming and structure - Research Data Management at ...

Files should be named consistently · File names should be short but descriptive (<25 characters) (Briney, 2015) · Avoid special characters or ...