Skip to content

Requesting improved documentation by examples and more detailed comments #46

@atljoseph

Description

@atljoseph

Am very appreciative of you work on this. Please add more documentation via examples, with comments on every line, and more realistic scenarios. I know this seems like just a chore, and it’s easier said than done, but needs to be done. For example, examples were last updated 4 years ago, but last update seems to have been 26 days ago, to the Readme. I have to fight for better documentation at work every day :) Always tough to justify the time spent on it. But I find that, as a result, people tend to get a more solid start, ask fewer “dumb” questions along the way, use the code in the right way, figure out issues more efficiently on their own, and they are more willing to contribute in kind when they resolve the eventual bug. Thank you

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions