Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add more usage examples and documentation

See original GitHub issue

Is your feature request related to a problem? Please describe. Users aren’t aware of what features are available in lyricsgenius and are requesting features that are already a part of the package.

Describe the solution you’d like Add documentation to the README that includes examples for more use cases. Eventually it would be nice to have a dedicated documentation site.

Issue Analytics

State:
Created 5 years ago
Comments:5 (2 by maintainers)

Top GitHub Comments

2reactions

leblanchannahcommented, Mar 27, 2019

Thanks! I will start out with 1.

1reaction

johnwmillrcommented, Sep 7, 2020

Yes. More usage examples are always welcome, but #153 was sufficient to close this issue.

Top Results From Across the Web

Adding Examples - Swagger

You can add examples to parameters, properties and objects to make OpenAPI ... Note for Swagger UI users: Support for multiple examples is...

Documenting Python Code: A Complete Guide

A complete guide to documenting Python code. Whether you're documenting a small script or a large project, whether you're a beginner or seasoned...

How to Write Doc Comments for the Javadoc Tool - Oracle

This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, ...

Specifying examples - Postman Learning Center

You can add an example to a request by saving a response, or you can create an example with a custom response to...

Microsoft Editor checks grammar and more in documents, mail ...

Identify spelling, grammar, and stylistic issues within your documents. ... extension for Edge and Chrome, and it's being added to Word and Outlook...