Skip to content

Conversation

Shitanshukumar607
Copy link
Contributor

@Shitanshukumar607 Shitanshukumar607 commented Oct 1, 2025

Description

Add documentation for functions in python
image

Fixes #640

Type of Change

  • New feature (e.g., new page, component, or functionality)
  • Bug fix (non-breaking change that fixes an issue)
  • UI/UX improvement (design, layout, or styling updates)
  • Performance optimization (e.g., code splitting, caching)
  • Documentation update (README, contribution guidelines, etc.)
  • Other (please specify):

Changes Made

Dependencies

  • List any new dependencies or tools required for this change.
  • Mention any version updates or configurations that need to be considered.

Checklist

  • My code follows the style guidelines of this project.
  • I have tested my changes across major browsers and devices
  • My changes do not generate new console warnings or errors .
  • I ran npm run build and attached screenshot(s) in this PR.
  • This is already assigned Issue to me, not an unassigned issue.

@Copilot Copilot AI review requested due to automatic review settings October 1, 2025 13:48
Copy link

vercel bot commented Oct 1, 2025

@Shitanshukumar607 is attempting to deploy a commit to the recode Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

github-actions bot commented Oct 1, 2025

Synced data from Linked Issues

Labels:

  • enhancement
  • gssoc25
  • level 1
  • recode
  • hacktoberfest-accepted

Assignees:

  • Shitanshukumar607

Milestones:

  • recode:launch 3.0

@github-actions github-actions bot added level 1 10 points recode this is label for leaderboard labels Oct 1, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation for Python functions to the documentation site. The addition covers fundamental concepts like function definition, parameters, return values, scope, and advanced topics like lambda functions and best practices.

  • Added complete Python functions documentation covering basic to advanced concepts
  • Updated sidebar navigation to include the new functions documentation page

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
sidebars.ts Added 'python/python-functions' entry to the Python section navigation
docs/python/python-functions.md Created comprehensive 464-line documentation covering Python functions from basics to advanced topics

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

print(sum_all(10)) # Output: 10
```

### Combining Regular Parameters with \*args
Copy link

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The backslash before the asterisk in the heading is unnecessary and creates incorrect formatting. It should be *args without the backslash.

Suggested change
### Combining Regular Parameters with \*args
### Combining Regular Parameters with `*args`

Copilot uses AI. Check for mistakes.

# city: New York
```

### Combining \*args and \*\*kwargs
Copy link

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The backslashes before the asterisks in the heading are unnecessary and create incorrect formatting. It should be *args and **kwargs without the backslashes.

Suggested change
### Combining \*args and \*\*kwargs
### Combining *args and **kwargs

Copilot uses AI. Check for mistakes.

Copy link

github-actions bot commented Oct 1, 2025

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. The estimated time for response is 5–8 hrs.

In the meantime, please provide all necessary screenshots and make sure you run - npm build run , command and provide a screenshot, a video recording, or an image of the update you made below, which helps speed up the review and assignment. If you have questions, reach out to LinkedIn. Your contributions are highly appreciated!😊

Note: I maintain the repo issue every day twice at 8:00 AM IST and 9:00 PM IST. If your PR goes stale for more than one day, you can tag and comment on this same issue by tagging @sanjay-kv.

We are here to help you on this journey of open source. Consistent 20 contributions are eligible for sponsorship 💰

🎁 check our list of amazing people we sponsored so far: GitHub Sponsorship. ✨

📚Your perks for contribution to this community 👇🏻

  1. Get free Consultation use code recode50 to get free: Mentorship for free.

  2. Get the Ebook for free use code recode at checkout: Data Science cheatsheet for Beginners.

  3. Check out this weekly Newsletter: Sanjay's Newsletter.

If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

@Shitanshukumar607
Copy link
Contributor Author

@sanjay-kv could you also increase the gssoc level?

Copy link

vercel bot commented Oct 1, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
recode-website Ready Ready Preview Comment Oct 2, 2025 9:26am

@sanjay-kv
Copy link
Member

00:06:18.237 Running build in Washington, D.C., USA (East) – iad1
00:06:18.237 Build machine configuration: 4 cores, 8 GB
00:06:18.262 Cloning github.com/recodehive/recode-website (Branch: functions-in-py, Commit: 72fa7ff)
00:06:21.462 Cloning completed: 3.200s
00:06:21.599 Restored build cache from previous deployment (CZA1dnB7wmfbCSbMAGXEKcgf7LGa)
00:06:22.610 Running "vercel build"
00:06:23.026 Vercel CLI 48.1.6
00:06:23.637 Warning: Detected "engines": { "node": ">=18.0" } in your package.json that will automatically upgrade when a new major Node.js Version is released. Learn More: http://vercel.link/node-version
00:06:23.641 Installing dependencies...
00:06:32.408 npm warn deprecated [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
00:06:32.423 npm warn deprecated [email protected]: Rimraf versions prior to v4 are no longer supported
00:06:32.654 npm warn deprecated [email protected]: Glob versions prior to v9 are no longer supported
00:06:34.288
00:06:34.289 added 101 packages, removed 13 packages, and changed 10 packages in 10s
00:06:34.289
00:06:34.289 449 packages are looking for funding
00:06:34.289 run npm fund for details
00:06:34.968 Running "npm run build"
00:06:35.086
00:06:35.086 > [email protected] build
00:06:35.086 > docusaurus build
00:06:35.086
00:06:37.260 [WARNING] The siteConfig.onBrokenMarkdownLinks config option is deprecated and will be removed in Docusaurus v4.
00:06:37.261 Please migrate and move this option to siteConfig.markdown.hooks.onBrokenMarkdownLinks instead.
00:06:37.277 [INFO] [en] Creating an optimized production build...
00:06:37.281 [WARNING] The siteConfig.onBrokenMarkdownLinks config option is deprecated and will be removed in Docusaurus v4.
00:06:37.281 Please migrate and move this option to siteConfig.markdown.hooks.onBrokenMarkdownLinks instead.
00:06:37.935
00:06:37.935 [ERROR] Error: Unable to build website for locale en.
00:06:37.935 at tryToBuildLocale (/vercel/path0/node_modules/@docusaurus/core/lib/commands/build/build.js:83:15)
00:06:37.935 at async /vercel/path0/node_modules/@docusaurus/core/lib/commands/build/build.js:35:9
00:06:37.936 ... 4 lines matching cause stack trace ...
00:06:37.936 at async file:///vercel/path0/node_modules/@docusaurus/core/bin/docusaurus.mjs:44:3 {
00:06:37.936 [cause]: Error: Invalid name=docusaurus-plugin-ideal-image version number=3.8.1.
00:06:37.936 All official @docusaurus/* packages should have the exact same version as @docusaurus/core (number=3.9.1).
00:06:37.936 Maybe you want to check, or regenerate your yarn.lock or package-lock.json file?
00:06:37.936 at /vercel/path0/node_modules/@docusaurus/core/lib/server/siteMetadata.js:66:19
00:06:37.936 at Array.forEach ()
00:06:37.936 at checkDocusaurusPackagesVersion (/vercel/path0/node_modules/@docusaurus/core/lib/server/siteMetadata.js:61:49)
00:06:37.936 at createSiteMetadata (/vercel/path0/node_modules/@docusaurus/core/lib/server/siteMetadata.js:80:5)
00:06:37.936 at createSiteProps (/vercel/path0/node_modules/@docusaurus/core/lib/server/site.js:99:64)
00:06:37.936 at loadSite (/vercel/path0/node_modules/@docusaurus/core/lib/server/site.js:156:19)
00:06:37.937 at async buildLocale (/vercel/path0/node_modules/@docusaurus/core/lib/commands/build/buildLocale.js:33:18)
00:06:37.937 at async runBuildLocaleTask (/vercel/path0/node_modules/@docusaurus/core/lib/commands/build/build.js:98:5)
00:06:37.937 at async /vercel/path0/node_modules/@docusaurus/core/lib/commands/build/build.js:79:13
00:06:37.937 at async tryToBuildLocale (/vercel/path0/node_modules/@docusaurus/core/lib/commands/build/build.js:75:9)
00:06:37.937 at async /vercel/path0/node_modules/@docusaurus/core/lib/commands/build/build.js:35:9
00:06:37.937 at async mapAsyncSequential (/vercel/path0/node_modules/@docusaurus/utils/lib/jsUtils.js:21:24)
00:06:37.937 at async Command.build (/vercel/path0/node_modules/@docusaurus/core/lib/commands/build/build.js:34:5)
00:06:37.937 at async Promise.all (index 0)
00:06:37.937 at async runCLI (/vercel/path0/node_modules/@docusaurus/core/lib/commands/cli.js:56:5)
00:06:37.937 at async file:///vercel/path0/node_modules/@docusaurus/core/bin/docusaurus.mjs:44:3
00:06:37.937 }
00:06:37.938 [INFO] Docusaurus version: 3.9.1
00:06:37.938 Node version: v22.20.0
00:06:37.955 Error: Command "npm run build" exited with 1

@sanjay-kv
Copy link
Member

@build failed. check the log please. @Shitanshukumar607

@Shitanshukumar607
Copy link
Contributor Author

@sanjay-kv it works now
image
I doubt it was created by my changes tho
image

Copy link
Member

@sanjay-kv sanjay-kv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome.

@sanjay-kv
Copy link
Member

can u try pull and push again, vercel has been failed again.

@Copilot Copilot AI review requested due to automatic review settings October 2, 2025 09:21
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

src/pages/careers/index.tsx:226

  • Link components are missing href attributes. Without href attributes, these links will not function as navigation elements and may not be accessible to screen readers or keyboard navigation.
              <Link
                className="bg-white text-blue-600 px-8 py-4 rounded-lg font-semibold hover:bg-blue-50 transition-all duration-300 transform hover:scale-105 shadow-lg"
              >
                View Open Positions
              </Link>
              <Link
                className="bg-white text-blue-600 px-8 py-4 rounded-lg font-semibold hover:bg-blue-50 transition-all duration-300 transform hover:scale-105 shadow-lg"
              >
                Learn About Our Culture
              </Link>

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@sanjay-kv sanjay-kv merged commit cab0103 into recodehive:main Oct 2, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in @recode-web Oct 2, 2025
@Shitanshukumar607
Copy link
Contributor Author

@sanjay-kv could you please add gssoc label? Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc25 hacktoberfest-accepted level 1 10 points recode this is label for leaderboard

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

💡[Feature]: Add topic: Functions in Python

2 participants