Skip to content

Commit aaa1155

Browse files
committed
Remove TODOs from README.md
Tracking these through issues is better. Also, `rustfmt` only needs to be called on top-level files (see rust-lang/rustfmt#2426). It does need to be called on every example, though, as those count as top-level files. Mention that signed GPG commits are preferred. Tree-SHA512: 5e4a308e71a6dd437a93f337820eb817185c235bb2796bcf28d91e1e45f91cbce5dc7e305e7adc7ee96c4292ab91fa89eb932a0b0007f98191740a9d15ddb03f
1 parent 7c93d07 commit aaa1155

File tree

2 files changed

+8
-23
lines changed

2 files changed

+8
-23
lines changed

README.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -58,30 +58,11 @@ Be aware that the API (of rust-clighting-rpc, but also that of c-lightning
5858
itself) is not finalized. This means that it may change from version to version and break your
5959
compile, sorry!
6060

61-
# To do
62-
63-
- verify use of `i64` versus `u64` in API
64-
- document low and high level handling
65-
- document error handling
66-
- reproducible functional test that exercises against actual lightning instances (regtest?)
67-
- a better way to get at the data for failed payments
68-
69-
```
70-
"code" : 205, "message" : "Could not find a route", "data" : ...
71-
```
72-
73-
`data` could be parsed into a structure, but this depends on the kind of error
74-
75-
- the API could make more use of enums where the possible values are known; for example the
76-
`addresstype` parameter to `newaddr`, but also in returned structures. This has to be weighted
77-
against flexibility, though, in case the API is extended later.
78-
79-
- decide on `&str` versus `String` on high-level API (but at least make sure it is consistent)
80-
81-
# Style guidelines
61+
# Contributing guidelines
8262

8363
- Four spaces
84-
- Call `rustfmt src/*.rs` before committing
64+
- Call `rustfmt src/lib.rs examples/*.rs` before committing
65+
- If you can, GPG-sign at least your top commit when filing a PR
8566

8667
# Credits
8768

examples/ex_1.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ fn main() {
1313
println!("getinfo result: {:?}", client.getinfo().unwrap());
1414

1515
for style in &["perkb", "perkw"] {
16-
println!("feerates {}: {:?}", style, client.feerates(style.to_string()).unwrap());
16+
println!(
17+
"feerates {}: {:?}",
18+
style,
19+
client.feerates(style.to_string()).unwrap()
20+
);
1721
}
1822
}

0 commit comments

Comments
 (0)