Coder Social home page Coder Social logo

Comments (3)

larsoner avatar larsoner commented on August 15, 2024 1

For now the easiest solution would be to say that the return type is BaseEpochs, which is nice because it is a documented type

from mne-python.

hoechenberger avatar hoechenberger commented on August 15, 2024

this problem affects many readers and I believe it has at least been brought up when we added some type hints not too long ago.

i agree with you that this should be improved.

parts of the class hierarchy would probably need to be revamped.

from mne-python.

nabilalibou avatar nabilalibou commented on August 15, 2024

A solution in the meantime to make sure the reader has all the keys needed to understand what's behind could be something like:

Returns:
   EpochsEEGLAB/EpochsKIT : instance of [BaseEpochs]
        EpochsEEGLAB/EpochsKIT object (subclass of [BaseEpochs])

And having a markdown box:

See also: 
   [mne.Epochs] Documentation of attributes and methods.

from mne-python.

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.