Skip to content

Commit

Permalink
Added notes
Browse files Browse the repository at this point in the history
Added notes
  • Loading branch information
madhurimarawat authored Dec 6, 2024
1 parent b19f5be commit 68f53f1
Show file tree
Hide file tree
Showing 28 changed files with 1,305 additions and 0 deletions.
Binary file added 7 SEMESTER/Data Wrangling/Notes/Unit 1/EDA.pptx
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Command Descriptions for Setting Up a Git Repository

## GitHub CLI Command

```bash
gh repo create Learning-Git --private --source=. --remote=origin
```

This command uses the GitHub CLI (`gh`) to create a new private repository named `Learning-Git` on GitHub. It uses the current directory (`.`) as the source for the new repository and sets up a remote named `origin`. The repository is available at: https://github.com/madhurimarawat/Learning-Git.

## Git and Directory Setup Commands

```bash
mkdir Learning-Git
```

Creates a new directory named `Learning-Git`. This will be the local folder where the Git repository will be initialized.

```bash
cd Learning-Git
```

Changes the current working directory to `Learning-Git`, so you are inside the folder you just created.

```bash
git remote add origin https://github.com/username/Learning-Git.git
```

Adds a remote repository named `origin` that points to the URL `https://github.com/madhurimarawat/Learning-Git.git`. This remote repository will be the location where you can push and pull changes.

```bash
git branch -M main
```

Renames the current branch to `main`. The `-M` option forces the renaming even if a branch named `main` already exists.

```bash
git push -u origin main
```

Pushes the `main` branch to the remote repository `origin`. The `-u` option sets this remote branch as the default upstream branch for future push and pull commands.

```bash
git remote add origin https://github.com/madhurimarawat/Learning-Git.git
```

Attempts to add another remote repository named `origin` pointing to `https://github.com/madhurimarawat/Learning-Git.git`. However, this would result in an error if a remote named `origin` already exists.

# Note

The correct repository link is: https://github.com/madhurimarawat/Learning-Git
The folder name for this project should be `Learning-Git`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Command Descriptions for Setting Up a Git Repository


## GitHub CLI Command

```bash
gh repo create Learning-Git --private --source=. --remote=origin
```

This command uses the GitHub CLI (`gh`) to create a new private repository named `Learning-Git` on GitHub. It uses the current directory (`.`) as the source for the new repository and sets up a remote named `origin`. The repository is available at: https://github.com/madhurimarawat/Learning-Git.

## Git and Directory Setup Commands

```bash
mkdir Learning-Git
```

Creates a new directory named `Learning-Git`. This will be the local folder where the Git repository will be initialized.


```bash
cd Learning-Git
```

Changes the current working directory to `Learning-Git`, so you are inside the folder you just created.


```bash
git remote add origin https://github.com/username/Learning-Git.git
```

Adds a remote repository named `origin` that points to the URL `https://github.com/madhurimarawat/Learning-Git.git`. This remote repository will be the location where you can push and pull changes.


```bash
git branch -M main
```

Renames the current branch to `main`. The `-M` option forces the renaming even if a branch named `main` already exists.


```bash
git push -u origin main
```

Pushes the `main` branch to the remote repository `origin`. The `-u` option sets this remote branch as the default upstream branch for future push and pull commands.


```bash
git remote add origin https://github.com/madhurimarawat/Learning-Git.git
```

Attempts to add another remote repository named `origin` pointing to `https://github.com/madhurimarawat/Learning-Git.git`. However, this would result in an error if a remote named `origin` already exists.

# Note
The correct repository link is: https://github.com/madhurimarawat/Learning-Git
The folder name for this project should be `Learning-Git`.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# MIT License for learning Git
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#My New Repository for learning Git
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
print(Hello World)
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
<!--
Author: Madhurima Rawat
Date: 21 November 2024
Brief: This HTML page provides a comparison between code comments, markdown, and Jupyter notebooks.
It explains their purposes, file extensions, syntax, and key differences across various criteria, such as execution capability, interactivity, and learning curve.
The comparison table is designed to help users understand the distinct features and use cases for each method of documenting and presenting code.
Additional Details:
- Color Palette: The table uses a vibrant color scheme with shades like coral, teal, lavender, and light yellow to create a visually appealing and easy-to-read format.
- Emoji Usage: Each column header and row criterion is accompanied by a relevant emoji (e.g., 💬 for code comments, 📝 for markdown, 📓 for Jupyter notebooks), making the table more engaging and visually interactive.
- Design: The alternating row colors and contrasting header cells make the table easy to read, while a centered heading and footer give the page a balanced, clean look.
- Purpose: The goal of this page is to compare different forms of documentation—code comments, markdown, and Jupyter notebooks—highlighting their strengths and ideal use cases in software development, data analysis, and collaborative research.
-->


<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Comments, Markdown, and Notebooks</title>
<style>
body {
font-family: Arial, sans-serif;
background-color: #f7f7ff;
margin: 20px;
color: #333;
text-align: center;
}

h1 {
color: #FF6347;
margin-bottom: 20px;
}
</style>
</head>

<body>

<h1>Comparison of Code Comments 💬, Markdown 📝, and Jupyter Notebooks 📓</h2>

<table border="1" cellpadding="10" cellspacing="0">
<thead>
<tr style="background-color: #FF6347; color: white;">
<th><strong>Criteria</strong> 📋</th>
<th><strong>Code Comments</strong> 💬</th>
<th><strong>Markdown</strong> 📝</th>
<th><strong>Jupyter Notebook</strong> 📓</th>
</tr>
</thead>
<tbody>
<tr style="background-color: #FFB6A1;">
<td style="background-color: #FF6347; color: white;"><strong>Purpose 📝</strong> </td>
<td>Explain code logic, add notes within code files</td>
<td>Create formatted documentation and text</td>
<td>Combine code, text, and output for interactive documents</td>
</tr>
<tr style="background-color: #FFE4B5;">
<td style="background-color: #FF4500; color: white;"><strong>File Extensions 🗂️</strong> </td>
<td>.py, .js, .c, etc. (depends on the language)</td>
<td>.md, .markdown</td>
<td>.ipynb</td>
</tr>
<tr style="background-color: #FFDAB9;">
<td style="background-color: #FF8C00; color: white;"><strong>Ownership 🏢</strong> </td>
<td>General standard across programming languages</td>
<td>Developed by John Gruber (open-source standard)</td>
<td>Initially developed by Fernando Pérez and IPython team (open-source)</td>
</tr>
<tr style="background-color: #F5F5DC;">
<td style="background-color: #FFD700; color: white;"><strong>Syntax Format 📄</strong> </td>
<td>Language-specific comment symbols (` //`, `#`, `/* */`)</td>
<td>Uses simple markup like `#`, `**`, `[]()`</td>
<td>Uses Markdown for text cells and Python for code cells</td>
</tr>
<tr style="background-color: #F5F5F5;">
<td style="background-color: #ADFF2F; color: white;"><strong>Text Formatting ✍️</strong> </td>
<td>Limited to plain text</td>
<td>Supports bold, italics, headings, etc.</td>
<td>Supports full Markdown formatting with rendered output</td>
</tr>
<tr style="background-color: #F0FFF0;">
<td style="background-color: #32CD32; color: white;"><strong>Execution Capability ⚙️</strong> </td>
<td>No code execution</td>
<td>No code execution</td>
<td>Code cells can be executed, showing results inline</td>
</tr>
<tr style="background-color: #E0FFFF;">
<td style="background-color: #20B2AA; color: white;"><strong>Interactivity 🔄</strong> </td>
<td>Not interactive</td>
<td>Not interactive</td>
<td>Interactive; supports widgets, graphs, etc.</td>
</tr>
<tr style="background-color: #F0F8FF;">
<td style="background-color: #20B2AA; color: white;"><strong>Use Cases 📚</strong> </td>
<td>Inline code documentation</td>
<td>README files, project documentation</td>
<td>Data analysis, teaching, research papers</td>
</tr>
<tr style="background-color: #E6E6FA;">
<td style="background-color: #1E90FF; color: white;"><strong>Visual Output 🌟</strong> </td>
<td>Plain text only</td>
<td>Styled text formatting</td>
<td>Visual output such as graphs, images, and tables</td>
</tr>
<tr style="background-color: #FFEFD5;">
<td style="background-color: #FF1493; color: white;"><strong>Integration 🔗</strong> </td>
<td>Integrated into code editors and IDEs</td>
<td>Supported by most text editors and Git platforms</td>
<td>Requires Jupyter environment or compatible software</td>
</tr>
<tr style="background-color: #FFF5EE;">
<td style="background-color: #FF69B4; color: white;"><strong>Learning Curve 🎓</strong> </td>
<td>Minimal; simple to use</td>
<td>Easy for basic formatting; more for advanced features</td>
<td>Moderate; requires learning notebook environment</td>
</tr>
<tr style="background-color: #E6E6FA;">
<td style="background-color: #DC143C; color: white;"><strong>Version Control 📊</strong> </td>
<td>Managed as part of code</td>
<td>Easy to version-control (e.g., GitHub)</td>
<td>More complex to version-control due to JSON format</td>
</tr>
<tr style="background-color: #F0F8FF;">
<td style="background-color: #8A2BE2; color: white;"><strong>Execution Environment 🏃</strong> </td>
<td>Runs in the specific programming environment</td>
<td>Not executable</td>
<td>Executable in Jupyter Notebook, JupyterLab, or similar platforms</td>
</tr>
<tr style="background-color: #FFF0F5;">
<td style="background-color: #8B008B; color: white;"><strong>Collaboration 🤝</strong> </td>
<td>Shared as part of code reviews</td>
<td>Easy to collaborate via platforms like GitHub</td>
<td>Collaborative using JupyterHub and shared notebooks</td>
</tr>
<tr style="background-color: #F8F8FF;">
<td style="background-color: #800080; color: white;"><strong>Examples of Use 💡</strong> </td>
<td>`# This is a code comment`</td>
<td>`# This is a Markdown heading`</td>
<td>Markdown cell: `# Heading` + Code cell: `print("Hello")`</td>
</tr>
<tr style="background-color: #FFFACD;">
<td style="background-color: #4B0082; color: white;"><strong>Link to GitHub Repo 🔗</strong> </td>
<td>Used within codebase (e.g., [Sample Repo](#))</td>
<td>Often found in [README files](https://github.com/)</td>
<td>Common in [Jupyter repos](https://github.com/)</td>
</tr>
</tbody>
</table>
</body>

<br>
<footer>
<p style="color: #FF6347; font-size: 20px;"><b>&copy; 2024 Madhurima Rawat. All rights reserved.</b></p>
</footer>

</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
| **Criteria** | **Code Comments** | **Markdown** | **Jupyter Notebook** |
| ---------------------------- | ------------------------------------------------------ | ----------------------------------------------------- | -------------------------------------------------------------------- |
| 📝 **Purpose** | Explain code logic, add notes within code files | Create formatted documentation and text | Combine code, text, and output for interactive documents |
| 🗂️ **File Extensions** | .py, .js, .c, etc. (depends on the language) | .md, .markdown | .ipynb |
| 🏢 **Ownership** | General standard across programming languages | Developed by John Gruber (open-source standard) | Initially developed by Fernando Pérez and IPython team (open-source) |
| 📄 **Syntax Format** | Language-specific comment symbols (`//`, `#`, `/* */`) | Uses simple markup like `#`, `**`, `[]()` | Uses Markdown for text cells and Python for code cells |
| ✍️ **Text Formatting** | Limited to plain text | Supports bold, italics, headings, etc. | Supports full Markdown formatting with rendered output |
| ⚙️ **Execution Capability** | No code execution | No code execution | Code cells can be executed, showing results inline |
| 🔄 **Interactivity** | Not interactive | Not interactive | Interactive; supports widgets, graphs, etc. |
| 📚 **Use Cases** | Inline code documentation | README files, project documentation | Data analysis, teaching, research papers |
| 🌟 **Visual Output** | Plain text only | Styled text formatting | Visual output such as graphs, images, and tables |
| 🔗 **Integration** | Integrated into code editors and IDEs | Supported by most text editors and Git platforms | Requires Jupyter environment or compatible software |
| 🎓 **Learning Curve** | Minimal; simple to use | Easy for basic formatting; more for advanced features | Moderate; requires learning notebook environment |
| 📊 **Version Control** | Managed as part of code | Easy to version-control (e.g., GitHub) | More complex to version-control due to JSON format |
| 🏃 **Execution Environment** | Runs in the specific programming environment | Not executable | Executable in Jupyter Notebook, JupyterLab, or similar platforms |
| 🤝 **Collaboration** | Shared as part of code reviews | Easy to collaborate via platforms like GitHub | Collaborative using JupyterHub and shared notebooks |
| 🔗 **Examples of Use** | `# This is a code comment` | `# This is a Markdown heading` | Markdown cell: `# Heading` + Code cell: `print("Hello")` |
| 🔗 **Link to GitHub Repo** | Used within codebase (e.g., [Sample Repo](#)) | Often found in [README files](https://github.com/) | Common in [Jupyter repos](https://github.com/) |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading

0 comments on commit 68f53f1

Please sign in to comment.