🔒 python project documentation

[grim plume]

This is my first time working on a collaborative project on GitHub. I was asked to create documentation for a specific part of the project. The project involves building a site similar to IMDb and uses an external API.

To clarify, the documentation is divided into four parts, and my responsibility is External API Integration.

Could you guide me on what exactly needs to be included in this documentation?

[grizzled quest]

@grim plume

Python help channel opened

Remember to:

• Ask your Python question, not if you can ask or if there's an expert who can help.
• Show a code sample as text (rather than a screenshot) and the error message, if you've got one.
• Explain what you expect to happen and what actually happens.

:warning: Do not pip install anything that isn't related to your question, especially if asked to over DMs.

Closes after a period of inactivity, or when you send !close.

[grim plume]

the blue open is open someother one created it

i need to make the red one

they say make documentation on external api intregation and push it in the api_intregation.md

[wind token]

Based on this it seems that you're supposed to document your thought process, research, and also any code that you wrote. You must have created some classes/functions for integrating that API, right?

[grim plume]

they said prepare it before we start project

we didnt code a single line

[grim plume]

they said it a frist step of project

[wind token]

Before...
Well, I guess then you just write about the external API. Note down which endpoints are of interest to your project, what the pricing is (if any), and so on.

And also how you plan to do the integration itself. Like, your design for making classes and functions for accessing the API

[grim plume]

i make one a liitle think maybe it just overview do i send u that?

[dire crane]

they want you to document your process before you actually do the process ?

it wont be documentation , its just planning

when you actually implement stuff , you might find that the path you chose is not the optimal and you might change your approach

[grim plume]

like in rate limiting the img i send u he just send how we use the sliding windoew counter and how we will implement it what will be Tunable Parameters

2 part of same page

[dire crane]

ok then you can just implement the proposed idea /plan you are going to follow and write about stuff like this #1407978466913161329 message

having an idea of what exactly you are doing would probably better help people in giving you advice

insteada of just a "concept"

[grim plume]

i made this for documentation ..been 1 day

but i am too scared to push it bcz i have no idea what documention means here

@wind token

[dire crane]

this just looks like the documentation of TMDB API

[grim plume]

yeah we r making the ibdm type site with python as backend

and my topic is external api intregation

[dire crane]

i think you are supposed to write how you will use this API in your project , how you will tackle the rate lmiting etc and whatnot

[dire crane]

again , you are supposed to write documentation for your application
not for TMDB api

[grim plume]

ok i try writing again ...

[dire crane]

and actually try to write it
instead of getting GPT to generate it

because GPT doesnt know what your project is , you do

[grim plume]

thanks

[grizzled quest]

Python help channel closed for inactivity

This help channel has been closed. Feel free to create a new post in #1035199133436354600. To maximize your chances of getting a response, check out this guide on asking good questions.