Go: Memory Model entry file #1435
Conversation
|
|
SSwiniarski
added
new entry
There was a problem hiding this comment.
@ethersea I did a first review and left a few comments for you.
| @@ -0,0 +1,73 @@ | |||
| --- | |||
| Title: 'Go: Memory' | |||
| Description: 'The Go memory model specifies the rules for how memory is accessed and modified in concurrent programs. It allows for the concurrent execution of multiple threads and includes operations such as reading, writing, allocating, and freeing memory. ' | |||
There was a problem hiding this comment.
The description could be shorter. I'd remove the second sentence and incorporate the information in the first paragraph of the article proper.
| Subjects: | ||
| - 'Computer Science' | ||
| - 'Developer Tools' | ||
|
|
There was a problem hiding this comment.
Remove the extra line breaks between sections in the metadata.
| - 'paths/computer-science' | ||
| --- | ||
|
|
||
| # Go: Memory Model |
There was a problem hiding this comment.
Remove this header. The title in the metadata will be the title when the article is published. H1 headers should not be used in the article body.
|
|
||
| In Go, there are several basic operations that can be performed on memory: | ||
|
|
||
| 1. **Reading**: This operation involves accessing a memory location and obtaining the value stored at that location. For example: |
There was a problem hiding this comment.
I think this would be laid out better if headers were used instead of the list you're using now. i.e.
### 1. Reading
This operation involves accessing a memory location and obtaining the value stored at that location...
### 2. Writing
This operation involves storing a value in a specific memory location...
etc.
|
|
||
| ## Memory Model | ||
|
|
||
| The Go memory model is a set of rules that dictate how memory operations can be performed in a concurrent program. These rules specify the order in which memory operations must be performed and how they can be observed by different threads. |
There was a problem hiding this comment.
Can we go into a little more details about what the rules are?
SSwiniarski
added
status: review 1️⃣ completed
status: waiting for author
and removed
status: under review
|
@SSwiniarski hello, sorry, I've made all changes that you requested but I'm having a hard time pushing them. Can I create a new PR? |
|
@ethersea what problems are you having? Maybe someone on the team can help you. |
|
@SSwiniarski I've pulled the updates to my local branch, but it still giving me this error when I'm trying to push. do I have to rebase my separate branch to local main? |
Co-authored-by: SSwiniarski <[email protected]>
|
@ethersea, were you able to resolve your problems? |
|
@ethersea @SSwiniarski I'll take a look at this PR and help push up some changes. Please let me know if this is not ideal, otherwise, I'll continue with getting this entry up to standards for merge! |
content/go/concepts/memory/memory.md
Outdated
|
|
||
| ## Ordering of Memory Operations | ||
|
|
||
| However, the Go memory model also requires that certain memory operations be performed in a specific order to ensure that the program behaves correctly. For example, a write operation must occur before a read operation which depends on the written value. |
There was a problem hiding this comment.
| However, the Go memory model also requires that certain memory operations be performed in a specific order to ensure that the program behaves correctly. For example, a write operation must occur before a read operation which depends on the written value. | |
| The Go memory model also requires that certain memory operations be performed in a specific order to ensure that the program behaves correctly. For example, a write operation must occur before a read operation which depends on the written value. |
|
👋 @ethersea |
|
@ethersea, congrats on your new contribution! You can see the live entry here: https://www.codecademy.com/resources/docs/go/memory It appears that you're anonymous: If you want to be credited follow the instructions below to add your GitHub username to your Codecademy profile. If not, there is nothing more you need to do. To add your GitHub username to your Codecademy profile: 2.) Then log out and log back into Codecademy using your GitHub login: |
* Add Go Memory Model entry file * Update content/go/concepts/memory/go-memory.md Co-authored-by: SSwiniarski <[email protected]> * Fix tests * Reword beginning of paragraph --------- Co-authored-by: SSwiniarski <[email protected]> Co-authored-by: Christine Yang <[email protected]>
Description
This pull request adds a new markdown file to Codecademy Docs that provides an overview of the Go Memory Model and Memory Operations. The file can be found at content/go/concepts/memory/go-memory.md.
This pull request also closes issue #943.
Type of Change
Checklist
mainbranch.