From 854341a23dde1f85f207f738de7e9452d591fd7d Mon Sep 17 00:00:00 2001 From: Nate Armstrong <naterarmstrong@gmail.com> Date: Tue, 15 Aug 2023 01:06:06 -0700 Subject: [PATCH] Remove missing sentence (#14769) --- substrate/docs/DOCUMENTATION_GUIDELINES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/substrate/docs/DOCUMENTATION_GUIDELINES.md b/substrate/docs/DOCUMENTATION_GUIDELINES.md index 93b8672b8a4..0f83f5e6445 100644 --- a/substrate/docs/DOCUMENTATION_GUIDELINES.md +++ b/substrate/docs/DOCUMENTATION_GUIDELINES.md @@ -71,8 +71,8 @@ Use `# Examples as much as possible. These are great ways to further demonstrate You can also consider having an `# Error` section optionally. Of course, this only applies if there is a `Result` being returned, and if the `Error` variants are overly complicated. -Strive to include correct links to other items in your written docs as much as possible. In other words, avoid \`some_func\` and instead use \[\`some_fund\`\]. Read more about how to correctly use links in your rust-docs [here](https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html#valid-links) and [here](https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html#additions-to-the-documentation-syntax). Strive to include correct links to other items in your written docs as much as possible. In other words, avoid `` `some_func` `` and instead use ``[`some_func`]``. +Read more about how to correctly use links in your rust-docs [here](https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html#valid-links) and [here](https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html#additions-to-the-documentation-syntax). > While you are linking, you might become conscious of the fact that you are in need of linking to (too many) foreign items in order to explain your API. This is leaning more towards API-Design rather than documentation, but it is a warning that the subject API might be slightly wrong. For example, most "glue" traits[^1] in `frame/support` should be designed and documented without making hard assumptions about particular pallets that implement them. -- GitLab