Coder Social home page Coder Social logo

Comments (5)

BenLauwens avatar BenLauwens commented on June 4, 2024 2

I will look at this issue but I think the workaround is the easiest way to document resumable functions

from resumablefunctions.jl.

detrin avatar detrin commented on June 4, 2024 1

I am using Documenter.jl and I have similar issue. The workaround is in my opinion only temporal solution. I suggest adding encapsulation of the function as follows

@resumable begin
"""
    filenames(...)

docstring
"""
function filenames(...)
...
end
end

from resumablefunctions.jl.

siddharthlal25 avatar siddharthlal25 commented on June 4, 2024

The workaround was:

"""
    filenames(...)

docstring
"""
function filenames end

@resumable function filenames(...)
...
end

It would be nice to add a functionality that allows users to document directly above @resumable function.

from resumablefunctions.jl.

hdavid16 avatar hdavid16 commented on June 4, 2024

Yes, this would be nice

from resumablefunctions.jl.

Krastanov avatar Krastanov commented on June 4, 2024

To be fixed in #71 - for future reference, one simply needs to use Base.@__doc__ for situations like this.

from resumablefunctions.jl.

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.