GithubHelp home page GithubHelp logo

Comments (4)

bitkarrot avatar bitkarrot commented on June 22, 2024

@ecurrencyhodler told me about this issue on stakwork. I am interested. @ShahanaFarooqui

from lightning.

cdecker avatar cdecker commented on June 22, 2024

I wonder if we should really be documenting these. We decided against including the dev- commands in the help output because they are, well, intended for developers. In addition they are commands that are mostly used to manipulate the internals during tests, and do not have a solid interface, i.e., we'd continually be breaking semantic versioning, or we'd have to start building tiny ad-hoc commands to test things in the tests.

These then would also be documented, exposed to users, and users that do not know the intricacies of the dev- commands may end up trying them out and destroying their node.

@rustyrussell what do you think?

from lightning.

ShahanaFarooqui avatar ShahanaFarooqui commented on June 22, 2024

Adding some context from where it started:
Reference issue: Ride-The-Lightning/RTL#1280

A user wanted to forget 3 channels and was unable to execute the command due to missing short_channel_id. Finally, @rustyrussell confirmed that channel_id can also be used. Then he asked to open an issue to add dev documentation with details so that advanced users can refer to the documentation if needed.

However, we can show these commands under advanced category with extra warning, if that helps.

from lightning.

bitkarrot avatar bitkarrot commented on June 22, 2024

I was just about to ask @ShahanaFarooqui to clarify the task.

Either way I am totally ok what your decision is, to document or not to document. I just got my environment updated and probably won't have time to work on it immediately, so no worries if you guys want to cancel this task. We can also just make a framework and leave it with placeholders if you want.

from lightning.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.