Skip to content
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.

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

Fixed doc missed #3938

Merged

Conversation

vincenzopalazzo
Copy link
Contributor

@vincenzopalazzo vincenzopalazzo commented Aug 13, 2020

All commands without documentation are

There are a couple of other commands such as stop, ping, listconfigs, getlog, getinfo, but I don't think these need a documentation file

The complete list here

   "commands": [
      "getinfo",
      "getlog",
      "help",
      "listconfigs",
      "listnodes",
      "ping",
      "sendpsbt",
      "signpsbt",
      "stop"
   ]

Update

The complete list of the commands is.

  • listtransactions
  • listnodes
  • signpsbt
  • sendpsbt
  • getinfo
  • getlog
  • help
  • listconfigs
  • ping
  • stop

doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
doc/lightning-listtransactions.7.md Outdated Show resolved Hide resolved
@vincenzopalazzo vincenzopalazzo force-pushed the documentation_improving branch 3 times, most recently from cf5a592 to 169967f Compare August 26, 2020 12:36
@vincenzopalazzo vincenzopalazzo marked this pull request as ready for review August 26, 2020 12:38
@vincenzopalazzo
Copy link
Contributor Author

Rebase 169967f

In addition, I have some problems with the command mrkd.

If I run the command mrkd doc/lightning-signpsbt.7.md doc/lightning-signpsbt.7 I have the following error

Traceback (most recent call last):
  File "/usr/local/bin/mrkd", line 8, in <module>
    sys.exit(main())
  File "/usr/local/lib/python3.6/dist-packages/mrkd.py", line 254, in main
    plac.call(entry_point)
  File "/usr/local/lib/python3.6/dist-packages/plac_core.py", line 417, in call
    cmd, result = parser.consume(arglist)
  File "/usr/local/lib/python3.6/dist-packages/plac_core.py", line 276, in consume
    return cmd, self.func(*(args + varargs + extraopts), **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/mrkd.py", line 225, in entry_point
    result = mistune.markdown(fp.read(), inline=inline, renderer=renderer)
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1184, in markdown
    return Markdown(escape=escape, **kwargs)(text)
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 994, in __call__
    return self.parse(text)
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1004, in parse
    out = self.output(preprocessing(text))
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1053, in output
    out += self.tok()
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1063, in tok
    return getattr(self, 'output_%s' % t)()
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1125, in output_list
    body += self.tok()
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1063, in tok
    return getattr(self, 'output_%s' % t)()
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1134, in output_list_item
    body += self.tok()
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1063, in tok
    return getattr(self, 'output_%s' % t)()
  File "/usr/local/lib/python3.6/dist-packages/mistune.py", line 1126, in output_list
    return self.renderer.list(body, ordered)
  File "/usr/local/lib/python3.6/dist-packages/mrkd.py", line 84, in list
    assert body[0] == '\0'
IndexError: string index out of range

I'm losing something?

@vincenzopalazzo vincenzopalazzo force-pushed the documentation_improving branch from 169967f to 7cbca71 Compare August 26, 2020 12:44
@rustyrussell
Copy link
Contributor

Change - -32602. to - -32602:.

@vincenzopalazzo vincenzopalazzo force-pushed the documentation_improving branch from 7cbca71 to 184525c Compare August 28, 2020 16:56
@vincenzopalazzo
Copy link
Contributor Author

Ops! Thanks to have fix that @rustyrussell

@vincenzopalazzo vincenzopalazzo force-pushed the documentation_improving branch from 184525c to 88de71e Compare August 31, 2020 12:43
Some additional detail was warranted in several places, though the
listconfigs is better off simply referring to lightningd-config.

Signed-off-by: Rusty Russell <[email protected]>
Changelog-Fixed: doc: Many missing manual pages were completed
@rustyrussell
Copy link
Contributor

I did another sweep on top of this one, and hope that I found all remaining issues!

@rustyrussell
Copy link
Contributor

Ack 8f1deed

@rustyrussell rustyrussell merged commit 3a49320 into ElementsProject:master Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants