Contributor Book: Fix the link of primitive types in the "Serialization" page #2362
+2
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Change the intra-doc link to an external one Keep consistent with other links in the book by referring to a specific commit instead of "main". Since there is no single commit used by all the links, simply pick the latest commit being used in pages under the "project-architecture" directory. * Better the wording of the link name
towerpark
changed the title
nathanielsimard
requested changes
Oct 13, 2024
| @@ -40,8 +40,8 @@ which field is a parameter or a constant, or we assume that each field implement | |||
|
|
|||
| The second solution was chosen as it simplifies the code generation and reduces the size of the user | |||
| API. This means that the `Module` trait should be implemented by | |||
| [primitives types](./burn-core/src/module/param/primitive.rs). The following diagrams highlight the | |||
| main types and traits used in the solution. | |||
| [primitive types](https://github.com/tracel-ai/burn/blob/6d96e8d8086d2309c425f2c8a43a8246f8c454d2/crates/burn-core/src/module/param/primitive.rs). | |||
There was a problem hiding this comment.
I would use the main branch for the link, otherwise it could become outdated. And for an architecture overview, that's fine not keeping up with versions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Checklist
run-checks allscript has been executed.(Executed with DISABLE_WGPU=1 because currently my development environment is in a container with no access to a physical GPU)
Related Issues/PRs
None.
Changes
Problems:
The link of primitive types in the "Serialization" page is an intra-doc link pointing to a place that doesn't exist. Also its name
primitives typesdoesn't sound very natural (English is not my first language, so please correct me if I'm wrong).Changes:
Replace the intra-doc link with an external one pointing to the source code file in "burn-core", and change its name to
primitive types.Testing
git diff.