Skip to content

Commit

Permalink
update docs for commit 891a8bc3
Browse files Browse the repository at this point in the history
  • Loading branch information
@vlang-bot
vlang-bot committed Oct 18, 2024
1 parent 4cf37d9 commit 934b2e2
Show file tree
Hide file tree
Showing 51 changed files with 198 additions and 168 deletions.
8 changes: 4 additions & 4 deletions appendix-i-keywords.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ <h1 class="main">Appendix I: Keywords</h1>
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L7984"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L8001"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -326,9 +326,9 @@ <h1 class="main">Appendix I: Keywords</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.498Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.744Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
8 changes: 4 additions & 4 deletions appendix-ii-operators.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ <h1 class="main">Appendix II: Operators</h1>
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L8037"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L8054"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -315,9 +315,9 @@ <h1 class="main">Appendix II: Operators</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.498Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.745Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
17 changes: 17 additions & 0 deletions assets/docs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5690,6 +5690,23 @@ pub mut:
Function/method deprecations:
Functions are deprecated before they are finally removed to give users time to migrate their code.
Adding a date is preferable in most cases. An immediate change, without a deprecation date, may be
used for functions that are found to be conceptually broken and obsoleted by much better
functionality. Other than that setting a date is advisable to grant users a grace period.
Deprecated functions cause warnings, which cause errors if built with `-prod`. To avoid immediate
CI breakage, it is advisable to set a future date, ahead of the date when the code is merged. This
gives people who actively developed V projects, the chance to see the deprecation notice at least
once and fix the uses. Setting a date in the next 30 days, assumes they would have compiled their
projects manually at least once, within that time. For small changes, this should be plenty time.
For complex changes, this time may need to be longer.
Different V projects and maintainers may reasonably choose different deprecation policies.
Depending on the type and impact of the change, you may want to consult with them first, before
deprecating a function.
```v
// Calling this function will result in a deprecation warning
Expand Down
8 changes: 4 additions & 4 deletions atomics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ <h1 class="main">Atomics</h1>
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L7103"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L7120"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -359,9 +359,9 @@ <h1 class="main">Atomics</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.442Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.688Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
19 changes: 16 additions & 3 deletions attributes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,19 @@ <h1 class="main">Attributes</h1>
}
</div>
<p>Function/method deprecations:</p>
<p>Functions are deprecated before they are finally removed to give users time to migrate their code.
Adding a date is preferable in most cases. An immediate change, without a deprecation date, may be
used for functions that are found to be conceptually broken and obsoleted by much better
functionality. Other than that setting a date is advisable to grant users a grace period.</p>
<p>Deprecated functions cause warnings, which cause errors if built with <code>-prod</code>. To avoid immediate
CI breakage, it is advisable to set a future date, ahead of the date when the code is merged. This
gives people who actively developed V projects, the chance to see the deprecation notice at least
once and fix the uses. Setting a date in the next 30 days, assumes they would have compiled their
projects manually at least once, within that time. For small changes, this should be plenty time.
For complex changes, this time may need to be longer.</p>
<p>Different V projects and maintainers may reasonably choose different deprecation policies.
Depending on the type and impact of the change, you may want to consult with them first, before
deprecating a function.</p>
<div class="language-v">// Calling this function will result in a deprecation warning

@[deprecated]
Expand Down Expand Up @@ -500,9 +513,9 @@ <h1 class="main">Attributes</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.323Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.569Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions builtin-functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -361,9 +361,9 @@ <h2 id="dumping-expressions-at-runtime">Dumping expressions at runtime <a href="
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.146Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.395Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
8 changes: 4 additions & 4 deletions call-stack.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ <h1 class="main">Call stack</h1>
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L6580"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L6597"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -308,9 +308,9 @@ <h1 class="main">Call stack</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.402Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.648Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions comments.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,9 +285,9 @@ <h1 class="main">Comments</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:30.888Z">Last updated:
2024-10-18 11:22:30, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.133Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions concurrency.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -560,9 +560,9 @@ <h2 id="shared-objects">Shared Objects <a href="concurrency.html#shared-objects"
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.252Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.500Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
8 changes: 4 additions & 4 deletions conditional-compilation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,7 @@ <h2 id="environment-specific-files">Environment specific files <a href="conditio
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L5829"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L5846"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -848,9 +848,9 @@ <h2 id="environment-specific-files">Environment specific files <a href="conditio
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.363Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.610Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions constants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -353,9 +353,9 @@ <h2 id="required-module-prefix">Required module prefix <a href="constants.html#r
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.143Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.392Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
8 changes: 4 additions & 4 deletions cross-compilation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ <h1 class="main">Cross compilation</h1>
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L7237"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L7254"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -305,9 +305,9 @@ <h1 class="main">Cross compilation</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.446Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.691Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
8 changes: 4 additions & 4 deletions debugger.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ <h1 class="main">Debugger</h1>
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L6454"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L6471"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -365,9 +365,9 @@ <h1 class="main">Debugger</h1>
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.399Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.646Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
8 changes: 4 additions & 4 deletions debugging.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ <h2 id="javascript-backend">Javascript Backend <a href="debugging.html#javascrip
<div class="edit-info">
<div class="edit-link">
<a class="link edit-link-button"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L7283"
href="https://github.com/vlang/v/edit/master/doc/docs.md#L7300"
target="_blank" rel="noreferrer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
class="edit-link-icon">
Expand All @@ -331,9 +331,9 @@ <h2 id="javascript-backend">Javascript Backend <a href="debugging.html#javascrip
</a>
</div>
<div class="last-updated">
<time datetime="2024-10-18T08:22:31.449Z">Last updated:
2024-10-18 11:22:31, V Commit: <a
href="https://github.com/vlang/v/commit/ce8f62146b1ec9d6efd264d893ca744c38add833">ce8f621</a></time>
<time datetime="2024-10-18T10:16:15.694Z">Last updated:
2024-10-18 13:16:15, V Commit: <a
href="https://github.com/vlang/v/commit/5ec9bb54b80bfde832e5fbfe78cd282b2ccac759">5ec9bb5</a></time>
</div>
</div>

Expand Down
Loading

0 comments on commit 934b2e2

Please sign in to comment.