GithubHelp home page GithubHelp logo

Comments (3)

murrayrm avatar murrayrm commented on June 20, 2024

My only concern would be that some examples might require a lot of setup that would make it verbose and less useful. Setting up something like an LQR problem, for example. But if we can do these succinctly, then I agree that we should have the goal that examples execute (so nosetests --with-doctest returns no errors).

from python-control.

cwrowley avatar cwrowley commented on June 20, 2024

I agree about the potentially verbose setup. LQR is a good example too, because the calling syntax is complex, and not immediately obvious from the function's signature lqr(*args, **kwargs). However, in the LQR documentation, I think the "Examples" section could actually be removed, since the syntax is already illustrated earlier in the doc string. Maybe formatting something like this could work for other routines where the setup is complicated too.

from python-control.

murrayrm avatar murrayrm commented on June 20, 2024

Fixed in PR #228.

from python-control.

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.