Skip to content

markdown: more tweaks #3124

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 5, 2017
Merged

markdown: more tweaks #3124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d6a9f3
markdown: replace arrows
robhoes Jul 5, 2017
0597d00
markdown: end md files with newline
robhoes Jul 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ocaml/doc/basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ qualifier is `RW` has an RPC accessor associated with it that sets its value:
Apart from the RPCs enumerated above, some classes have additional RPCs
associated with them. For example, the `VM` class has RPCs for cloning,
suspending, starting etc. Such additional RPCs are described explicitly
in the API reference.
Copy link
Contributor

@mseri mseri Jul 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what changed here ??

Copy link
Member Author

@robhoes robhoes Jul 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added newline.

Copy link
Contributor

@mseri mseri Jul 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😛

in the API reference.
10 changes: 5 additions & 5 deletions ocaml/doc/wire-protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ These types are mapped onto XML-RPC types in a straight-forward manner:
</array>
```

* for types `k` and `v`, our type `(k -> v) map` maps onto an
* for types `k` and `v`, our type `(k → v) map` maps onto an
XML-RPC `<struct>`, with the key as the name of the struct. Note that the
`(k -> v) map` type is only valid when `k` is a `string`, `ref`, or
`(k → v) map` type is only valid when `k` is a `string`, `ref`, or
`int`, and in each case the keys of the maps are stringified as
above. For example, the `(string -> double) map` containing the mappings
_Mike &rarr; 2.3_ and _John &rarr; 1.2_ would be represented as:
above. For example, the `(string → double) map` containing the mappings
_Mike → 2.3_ and _John → 1.2_ would be represented as:

```xml
<value>
Expand Down Expand Up @@ -313,4 +313,4 @@ To retrieve all the VM records in a single call:
['OpaqueRef:1', 'OpaqueRef:2', 'OpaqueRef:3', 'OpaqueRef:4' ]
>>> records['OpaqueRef:1']['name_label']
'Red Hat Enterprise Linux 7'
```
Copy link
Contributor

@mseri mseri Jul 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's another funny change!

Copy link
Member Author

@robhoes robhoes Jul 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same :)

Copy link
Contributor

@mseri mseri Jul 5, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😛

```
14 changes: 7 additions & 7 deletions ocaml/idl/markdown_backend.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ let rec of_ty_verbatim = function
| DateTime -> "datetime"
| Enum (name, things) -> name
| Set x -> sprintf "%s set" (of_ty_verbatim x)
| Map (a, b) -> sprintf "(%s -> %s) map" (of_ty_verbatim a) (of_ty_verbatim b)
| Map (a, b) -> sprintf "(%s → %s) map" (of_ty_verbatim a) (of_ty_verbatim b)
| Ref obj -> obj ^ " ref"
| Record obj -> obj ^ " record"

Expand All @@ -89,7 +89,7 @@ let rec of_ty = function
| DateTime -> "datetime"
| Enum (name, things) -> escape name
| Set x -> (of_ty x) ^ " set"
| Map (a, b) -> "(" ^ (of_ty a) ^ " &rarr; " ^ (of_ty b) ^ ") map"
| Map (a, b) -> "(" ^ (of_ty a) ^ " → " ^ (of_ty b) ^ ") map"
| Ref obj -> (escape obj) ^ " ref"
| Record obj -> (escape obj) ^ " record"

Expand Down Expand Up @@ -333,7 +333,7 @@ The following type constructors are used:
|:-----------------|:-------------------------------------------------------|
|_c_ ref |reference to an object of class _c_ |
|_t_ set |a set of elements of type _t_ |
|(_a &rarr; b_) map|a table mapping values of type _a_ to values of type _b_|
|(_a → b_) map |a table mapping values of type _a_ to values of type _b_|

### Enumeration types

Expand Down Expand Up @@ -393,8 +393,8 @@ like this:
<data>
<value>MAP_DUPLICATE_KEY</value>
<value>Customer</value>
<value>eSpeil Inc.</value>
<value>eSpeil Incorporated</value>
<value>eSpiel Inc.</value>
<value>eSpiel Incorporated</value>
</data>
</array>
</value>
Expand All @@ -405,9 +405,9 @@ like this:
Note that `ErrorDescription` value is an array of string values. The
first element of the array is an error code; the remainder of the array are
strings representing error parameters relating to that code. In this case,
the client has attempted to add the mapping _Customer &rarr;
the client has attempted to add the mapping _Customer →
eSpiel Incorporated_ to a Map, but it already contains the mapping
_Customer &rarr; eSpiel Inc._, and so the request has failed.
_Customer → eSpiel Inc._, and so the request has failed.

Each possible error code is documented in the following section.

Expand Down