Git Product home page Git Product logo

Comments (2)

christianmckinnon avatar christianmckinnon commented on August 11, 2024 1

Got it. Thank you so much for your feedback and I will keep that in mind for future contributions!

from spotipy.

dieser-niko avatar dieser-niko commented on August 11, 2024

There's already a restructuring underway that would solve this problem as well. See #1054.

Also, please don't use filler words. I don't mean to be rude or anything, but your issue can be compressed into a paragraph or two without losing context. The last paragraph can be removed entirely, as it is expected that everyone using git/GitHub knows how it works. You could even just open a pull request without the issue. Here's a quick rephrasing:

When landing on the documentation page, I noticed that the welcome message immediately transitions into a Spotify API example without clear separation. This lack of transition might disrupt the flow for newcomers. The accessible Python code snippets aim to show the ease of using the library but lack a subheading explaining their purpose.

Suggested Action:
Add a subheading, “A Quick Tutorial To Get Started,” after the introduction sentence to improve clarity and user-friendliness. This will help developers understand the code's purpose and navigate the documentation more effectively.

from spotipy.

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.