Commit Graph

58 Commits

Author SHA1 Message Date
snoppy
089278d817
docs+lntest: fix typos 2024-03-20 15:13:19 +08:00
Oliver Gugger
3a7e564582
docs: update Node.JS example
Fixes #8333 by not using the outdated `bytebuffer` library anymore.
2024-01-04 09:13:59 +01:00
Vincent
80bfd17cf2
docs: add instructions to generate type hints (#8025)
* Add instructions to generate type hints 

Use mypy to generate .pyi files as well. These files are useful for type hinting in IDEs.

* Update python.md

fix lines that got swapped in copy-paste

* remove mypy 

mypy is not a dependency
2023-10-06 16:47:17 +02:00
@RandyMcMillan
2b7c9019eb
docs/grpc/java.md: use /Users/<username>/..
Make MacOS user path consistent across docs
2023-07-14 16:44:28 -04:00
habibitcoin
04a1160939
docs: remove $ from multiline commands or frequently copied [skip ci] 2022-10-28 12:32:24 -05:00
habibitcoin
0b1e881d18
scripted-diff: replace ⛰ emoji with $ [skip ci]
-BEGIN VERIFY SCRIPT-
sed -i 's/⛰/$/g' $(git grep -l '⛰')
-END VERIFY SCRIPT-
2022-10-28 12:06:49 -04:00
mateuszmp
35b11ef791
docs: fix spelling in JavaScript example.
Fixed a spelling mistake in work "handshake" on line 33.
Stylized grpc to gRPC on line 32.
2022-01-11 14:08:20 +01:00
henta
f553462bf4
docs: Update grpc/java.md 2022-01-11 14:01:09 +01:00
Oliver Gugger
3385d38414
Merge pull request #5766 from JssDWt/update-csharp-grpc-docs-grpc.net.client
Update C# grpc docs to use Grpc.Net.Client
2021-09-29 12:02:03 +02:00
benthecarman
7a5467d6fe
Fix incorrect link in java gRPC docs [skip ci] 2021-09-24 02:38:52 -05:00
Jesse de Wit
0577a6086a docs: Update C# grpc docs to use Grpc.Net.Client
The Grpc.Core NuGet package is in maintentance mode. Grpc.Net.Client is now the recommended implementation.
2021-09-20 12:20:46 +02:00
mateuszmp
fd10d8d903
Replacing deprecated import with recommended replacement
npm module grpc is deprecated as of April 2021. 
The recommended replacement is @grpc/grpc-js. 
The replacement is compatible with the use cases presented in JS examples and so switching examples to it requires only changes to the list of npm modules to install and the imports.

Source for deprecation: https://www.npmjs.com/package/grpc
Source for replacement and compatibility information: https://www.npmjs.com/package/@grpc/grpc-js
2021-08-07 11:07:48 +02:00
Oliver Gugger
235efc04e4
docs+lnrpc: rename rpc.proto to lightning.proto
To avoid a naming conflict with etcd, we rename our very generic
rpc.proto to lightning.proto to match the service name that's declared
within. This will break many external tutorials and possibly also our
API docs but the change needs to be done eventually.
2021-07-27 12:59:56 +02:00
cryptosharks131
fe81049931 Add documentation to use global variable to update channel policies in python 2021-05-25 17:48:56 -04:00
Oliver Gugger
2c634bfaf3
docs: unify code and shell cmd blocks 2021-01-22 09:14:09 +01:00
Daniel Babbev
fd544e00ee
docs: update C# documentation 2020-11-03 17:29:55 -08:00
Oliver Gugger
b7ff6ab4ef
docs+javascript: add link to API documentation 2020-05-04 10:12:54 +02:00
Oliver Gugger
92abf3ed87
docs+javascript: switch to proto-loader 2020-05-04 10:12:54 +02:00
Oliver Gugger
d950b7e4b1
docs+javascript: remove broken macaroon example 2020-05-04 10:12:53 +02:00
Oliver Gugger
192bcc15b7
docs+javascript: uset let and const, fix example formatting 2020-05-04 10:12:49 +02:00
Oliver Gugger
af0bfd015a
docs+javascript: fix headings 2020-05-04 10:02:26 +02:00
Oliver Gugger
26998e13de
docs+python: add link to API documentation 2020-05-04 09:54:50 +02:00
Oliver Gugger
d1629e9cf4
docs+python: add build instructions for subserver modules 2020-05-04 09:54:15 +02:00
Oliver Gugger
0bb449c8fe
docs+python: fix headings, make numbered list 2020-05-04 09:53:40 +02:00
Brett Cawley
9d213948ba docs/grpc: add C# docs 2019-07-12 13:23:31 -07:00
Vincent Woo
5f1d859c0a Show in gRPC Ruby doc how to avoid GRPC::ResourceExhausted exceptions
Otherwise mainnet DescribeGraph calls will fail
2018-12-26 14:02:29 -08:00
Xavi Soler
ca9f572766 add num_inactive_channels field to docs 2018-11-05 09:11:01 +01:00
Vincent Woo
8103db60de Show how macaroon interceptor can work with streaming gRPC in Ruby doc 2018-10-26 14:17:35 -07:00
Vincent Woo
6dd4fde56a Fix incorrect hash key in gRPC Ruby documentation 2018-10-26 13:24:30 -07:00
Wilmer Paulino
dc3db4bf62 docs: update path to where macaroons are stored
Co-Authored-By: Karl Ranna <karl@karlranna.com>
2018-08-23 18:05:00 -07:00
Jack McCallum
42de4400bf docs/grpc: add macaroon and SSL Cipher info to Ruby gRPC docs 2018-05-24 19:15:23 -07:00
Richard Bondi
caf8139750 docs/grpc: correct javascript macaroon example
Creating and adding metadata in single line resulted in null `metadata`
2018-04-25 13:38:39 -07:00
Danny Paz
3c73329912 docs/grpc/javascript: updated docs to include macaroon and cipher suites 2018-04-17 18:42:55 -07:00
Karlson Lee
16c304a4c1 docs/grpc/python remove witness_only 2018-04-09 13:01:39 -07:00
Adrien Emery
9bf4bbb642 docs: encode macaroon in python grpc example
Previously `decode` was used incorrectly.
2018-03-22 22:41:33 -07:00
Adrien Emery
7fe719f77f docs: add correct cipher suit to python grpc example 2018-03-20 17:54:19 -07:00
Adrien Emery
5ef0d4c8b9 docs: update python grpc examples to use python 3 syntax 2018-03-20 13:42:53 -07:00
Adrien Emery
55e882c058 docs: add macaroon usage examples to python docs 2018-03-20 13:38:30 -07:00
Alex Gessner
9d34fa8c1e docs/grpc/ruby: fix incorrect documentation in ruby.md value to amt (#799) 2018-03-02 19:16:22 -08:00
Brenden Matthews
eed0e9ac67
docs: Show macaroon usage with Java GRPC example. 2018-02-28 16:19:48 -05:00
practicalswift
b8e1351cf3 multi: fix some recently introduced typos 2018-02-18 15:27:29 -08:00
practicalswift
a93736d21e multi: comprehensive typo fixes across all packages 2018-02-06 19:11:11 -08:00
Olaoluwa Osuntokun
b6235a536b
Merge pull request #587 from kingvest/master
docs/grpc: added instructions for writing gRPC clients in Ruby
2018-01-27 16:31:23 -08:00
Cristobal Griffero
ffbcf7db4f lncli: rename value to amt in addinvoice command 2018-01-27 14:52:46 -08:00
Maarten Tutak
a8728ccb5b docs: add example of Java gRPC client 2018-01-18 12:47:54 +01:00
kingvest
40ccc3f417
docs/grpc: added instructions for writing gRPC clients in Ruby
This commit adds a basic set of instructions for installing the necessary
gRPC dependencies to be able to drive `lnd` using Ruby.
2018-01-10 19:21:03 +01:00
Justus Kandzi
976655d172 docs: fix python example code issues 2018-01-03 18:09:00 +01:00
hackerrdave
ad40207126 provide formatting for lnd references 2018-01-03 11:39:35 +01:00
Ben Congdon
3f2f74bae7 docs: fix python path typo
`os.path.expanduser` is needed to evaluate paths relative to the user's home directory.
2017-12-13 15:32:25 -08:00
Nalin Bhardwaj
965fcf5bd6
docs: Modify example WalletBalance responses 2017-12-04 05:34:48 +05:30