Command formatting (see #10213) #248
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Following a discussion with Helen, we decided to now use the default_role to mmarkup commands instead of the :command: role.
- omerocmd role is now completely OS independent and :omerocmd:`command subcommand` now displays as omero command [subcommand] - when paths are needed, command/omerocmd are converted using file markup, e.g. :file:`bin/omero` - all other command are marked using the default role, e.g. `command`
README.rst
Outdated
Contributor
|
Mark up needs to be double back quotes to |
developers/using-git.txt
Outdated
Contributor
There was a problem hiding this comment.
This still needs reformatting to double back quotes
Contributor
|
Two format updates you missed then this is good to go :) |
Contributor
|
Changes look fine, I expect we'll end up spotting somewhere else we've missed but I think this is good to go for now. Ready to merge. |
joshmoore
added a commit
that referenced
this pull request
Feb 13, 2013
Command formatting (see #10213)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses a discussion thread initialized in #239 and stored in ticket 10213.
Unification of command markup is done as follows:
:literal:command`` role (double back quotes) instead of the:command:role. All the occurrences of the latter role are reviewed and replaced by the adequate form in the code.:omerocmd:role is changed intonodes.literalAdditionally, to solve the OS dependency of CLI commands, this PR implements the following:
:omerocmd:admin restart`` now displaysomero admin restartin the text and generates a `omero admin; restart` entry in the index table. The latter change allows the proper grouping of all the CLI command in the index.:file:role is used assuming the sentence refers to a (relative) file path, e.g.:file:bin/omeroor `:file:`bin\\omero/cc @bpindelski, @ximenesuk