diff options
Diffstat (limited to 'pydis_site/apps')
9 files changed, 38 insertions, 35 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md index d13a838f..fad54374 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md @@ -14,11 +14,11 @@ The following will use the [Sir-Lancebot](https://github.com/python-discord/sir- --- ## Cloning with PyCharm -1. Load up PyCharm and click `Get from VCS`. - +1. Load up PyCharm and click `Get from VCS`.<br> + 2. Enter the URL of your forked repository. -3. Change the directory if you desire and click `Clone`. - +3. Change the directory if you desire and click `Clone`.<br> + --- diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/docker.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/docker.md index e7ff7e96..2129342b 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/docker.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/docker.md @@ -76,11 +76,11 @@ Windows has not been configured to share drives with Docker. **Solution**<br> > NOTE: Solution requires Windows user credentials for an account that has administrative privileges. -1. Right-click the Docker icon in the Windows system tray, and choose "Settings" from the context menu. - +1. Right-click the Docker icon in the Windows system tray, and choose "Settings" from the context menu.<br> + -2. Click the "Shared Drives" label at the left, and check the box next to the drive letter where your project is stored. - +2. Click the "Shared Drives" label at the left, and check the box next to the drive letter where your project is stored.<br> + 3. Click "Apply" and enter appropriate Windows credentials (likely just your own account, if you have administrative privileges). diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/forking-repository.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/forking-repository.md index b8478269..07535dbe 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/forking-repository.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/forking-repository.md @@ -8,11 +8,11 @@ Before contributing to any project, you will have to fork the project, ie. creat The following will use the [Sir-Lancebot](https://github.com/python-discord/sir-lancebot/) repository as an example, but the steps are the same for all other repositories. 1. Navigate to the repository page and press the `Fork` button at the top of the page. - + 2. Fork it to your account.<br> - + 3. Later, you will need the Git URL of your forked repository in order to clone it. In your newly forked repository, copy the Git URL by clicking the green `Code` button, then click the Copy Link button. - + > If you have SSH set up with GitHub, you may instead click the `SSH` button above the Copy Link button to get the SSH URL. diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md index ff981110..4432236e 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md @@ -18,11 +18,11 @@ You should have already cloned your fork as described in [**Cloning a Repository 1. Load up your project in PyCharm. 2. Go to the Project Settings by clicking `File`, then `Settings...`. Alternatively, use the shortcut key `Ctrl+Alt+S`. 3. Navigate to `Project Interpreter`, then click the gear icon and click `Add`. - + 4. In the popup window, click `Pipenv Environment`, make sure `Install packages from Pipfile` is checked, then click `OK`. - + 5. PyCharm will automatically install the packages required into a virtual environment. - + --- diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/issues.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/issues.md index 3ec8ec69..52da95ce 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/issues.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/issues.md @@ -19,13 +19,13 @@ Often, an Issue ticket already exists within the scope of what you might be cons If you don't see one existing, then: Click the `Issues` tab in a repository:<br> - + Click `New Issue`<br> - + Enter the title and description for your issue, then click `Submit new issue`<br> -{: width="600" } +{: width="600" } ## What should I put as a title? diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/working-with-git/pycharm.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/working-with-git/pycharm.md index b3b5786e..93641ec4 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/working-with-git/pycharm.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/working-with-git/pycharm.md @@ -27,9 +27,9 @@ The following will use the [Sir-Lancebot](https://github.com/python-discord/sir- > Generally, a *remote* designates a repository that is on GitHub or another external location rather than on your computer. The `origin` remote will refer to your fork on GitHub. The `upstream` remote will refer to the main repository on GitHub. 1. In the menu bar, navigate to `Git` -> `Remotes...`.<br> - + 2. In the popup menu, click the `+` icon, set `upstream` as the name, set the URL as the URL for the main repository on GitHub.<br> - + 3. Click `OK`. --- @@ -42,14 +42,14 @@ The following will use the [Sir-Lancebot](https://github.com/python-discord/sir- > Before making new branches, be sure to checkout the `main` branch and ensure it's up to date. 1. In the bottom right corner, click on `main` and then click `New Branch`.<br> - + --- ## Committing Changes After making changes to the project files, you can commit by clicking the commit button that's part of the Git actions available in the top right corner of your workspace: - + The flow of making a commit is as follows: @@ -57,7 +57,7 @@ The flow of making a commit is as follows: 2. Write a brief description of what your commit is. This is your *commit message*. 3. See the actual changes your commit will be making, and optionally tick/untick specific changes to only commit the changes you want. 4. Click `Commit`.<br> - + --- @@ -65,7 +65,7 @@ The flow of making a commit is as follows: When you are ready to have your commits be available in your remote fork, navigate to `Git` -> `Push...`. Select the commits you want to push, make sure the remote branch is your intended branch to push to, and click `Push`. - + --- @@ -74,4 +74,4 @@ Select the commits you want to push, make sure the remote branch is your intende To do that, navigate to `Git` -> `Pull...`. From there, select the *remote* and the branches to pull from, then click `Pull`. - + diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/help-channel-guide.md b/pydis_site/apps/content/resources/guides/pydis-guides/help-channel-guide.md index 83322b3d..2a6e7781 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/help-channel-guide.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/help-channel-guide.md @@ -20,7 +20,7 @@ The topical help channels move at a slower pace than the general help channels. They also sometimes attract domain experts - for example, `#async-and-concurrency` has CPython contributors who helped write asyncio, and in `#game-development` you can find the creators and maintainers of several game frameworks. If your question fits into the domain of one of our topical help channels, and if you're not in a big hurry, then this is probably the best place to ask for help. - + Some of the topical help channels have a broad scope, so they can cover many (somewhat) related topics. For example, `#data-science-and-ai` covers scientific Python, statistics, and machine learning, while `#algos-and-data-structs` covers everything from data structures and algorithms to maths. @@ -38,20 +38,20 @@ It's particularly important to [ask good questions](..guides/asking-good-questio There are always 3 available help channels waiting to be claimed in the **Python Help: Available** category. - + In order to claim one, simply start typing your question into one of these channels. Once your question has been posted, you have claimed this channel, and the channel will be moved down to the **Python Help: Occupied** category. If you're unable to type into these channels, this means you're currently **on cooldown**. In order to prevent someone from claiming all the channels for themselves, **we only allow someone to claim a new help channel every 15 minutes**. However, if you close your help channel using the `!dormant` command, this cooldown is reset early. - + *This message is always posted when a channel becomes available for use.* ## Q: For how long is the channel mine? The channel is yours until it has been inactive for **30 minutes**. When this happens, we move the channel down to the **Python Help: Dormant** category, and make the channel read-only. After a while, the channel will be rotated back into **Python Help: Available** for the next question. Please try to resist the urge to continue bumping the channel so that it never gets marked as inactive. If nobody is answering your question, you should try to reformulate the question to increase your chances of getting help. - + *You'll see this message in your channel when the channel is marked as inactive.* ## Q: I don't need my help channel anymore, my question was answered. What do I do? @@ -62,7 +62,7 @@ Once you have finished with your help channel you or a staff member can run `!do Absolutely not. We strongly encourage all members of the community to help answer questions. If you'd like to help answer some questions, simply head over to one of the help channels that are currently in use. These can be found in the **Python Help: Occupied** category. - + Anyone can type in these channels, and users who are particularly helpful [may be offered a chance to join the staff on Python Discord](/pages/server-info/roles/#note-regarding-staff-roles). @@ -74,5 +74,5 @@ All the dormant help channels are still available at the bottom of the channel l If you're not sure what the name of your help channel was, you can easily find it by using the Discord Search feature. Try searching for `from:<your nickname>` to find the last messages sent by yourself, and from there you will be able to jump directly into the channel by pressing the Jump button on your message. - + *The dormant help channels can be found at the bottom of the channel list.* diff --git a/pydis_site/apps/content/resources/guides/python-guides/discordpy.md b/pydis_site/apps/content/resources/guides/python-guides/discordpy.md index 0dbac1c5..b0b2fad1 100644 --- a/pydis_site/apps/content/resources/guides/python-guides/discordpy.md +++ b/pydis_site/apps/content/resources/guides/python-guides/discordpy.md @@ -148,7 +148,7 @@ The following are a collated list of the most referenced community examples. #### Embeds * [Embed Live Designer and Visualiser](https://leovoel.github.io/embed-visualizer/) - *Credit to leovoel* * [Embed Element Reference](https://cdn.discordapp.com/attachments/84319995256905728/252292324967710721/embed.png)<br> -{: width="200" } +{: width="200" } ##### Using Local Images in Embeds ```py diff --git a/pydis_site/apps/content/resources/guides/python-guides/mutability.md b/pydis_site/apps/content/resources/guides/python-guides/mutability.md index 19e50819..45eb9d9f 100644 --- a/pydis_site/apps/content/resources/guides/python-guides/mutability.md +++ b/pydis_site/apps/content/resources/guides/python-guides/mutability.md @@ -30,10 +30,11 @@ It just returns a new one. Let's examine what's going on here. At first, the variable `s` refers to some object, the string `'hello'`. - + When you call `s.upper()`, a new string, which contains the characters `'HELLO'`, gets created. - + + This happens even if you just call `s.upper()` without any assignment, on its own line: ```python @@ -42,11 +43,13 @@ This happens even if you just call `s.upper()` without any assignment, on its ow In this case, a new object will be created and discarded right away. Then the assignment part comes in: the name `s` gets disconnected from `'hello'`, and gets connected to `'HELLO'`. - + + Now we can say that `'HELLO'` is stored in the `s` variable. Then, because no variables refer to the _object_ `'hello'`, it gets eaten by the garbage collector. - + + It means that the memory reserved for that object will be freed. If that didn't happen, the 'garbage' would accumulate over time and fill up all the RAM. |