Git Product home page Git Product logo

Comments (2)

wagnerpeer avatar wagnerpeer commented on July 17, 2024

Docstrings containing a section following the "Raises" section will result in pyment correctly parsing and generating an empty diff!
This can be tested inserting such a section into the example file tests/docs_already_numpydoc.py like the following:

def func1(param1):
    """Function 1
    with 1 param

    Parameters
    ----------
    param1 : type
        1st parameter

    Returns
    -------
    string
        a message

    Raises
    ------
    KeyError
        when a key error
    
    Notes
    -----
    Some notes
    """
    return "huh"

To debug the code I reactivated the already existing but commented test tests/pyment_test_cases.FilesConversionTests.testCaseNoGenDocsAlreadyNumpydoc.

To fix the issue one had to calculate the correct, positive relative end index in NumpydocTools.get_list_key instead of using -1 as end index.

But because there are more issues with already existing numpydoc which gets "converted" to numpydoc I left the tests untouched and I also did not modify the tests/docs_already_numpydoc.py file in the way I describe above as this would also obfuscate the current issue with using "Raises" as last section.

See PR #60

from pyment.

dadadel avatar dadadel commented on July 17, 2024

The issue is fixed by the wagnerpeer refactorization.

from pyment.

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.