Coder Social home page Coder Social logo

f_stats's People

Contributors

kalleleppala avatar

Watchers

James Cloos avatar  avatar

Forkers

kummahiih

f_stats's Issues

Embed unit tests to your API documentation

You seem to have usage examples in your documentation strings. It is a good idea to test that
they work, if you make any modification to the code. Also they work as a unit tests for your code. This can be done by using your module in the interpreter and then copy pasting the output of the interpreter directly to your documentation string. You can add a new file to your project, which runs your tests.

test.py:

if __name__ == "__main__":
    import doctest
    import f_stats
    globs = {
        'f_stats': f_stats
    }

    doctest.testfile(filename="f_stats.py",  globs=globs)

See https://docs.python.org/3/library/doctest.html?highlight=doctest#module-doctest

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.