Fix docs #181
Merged
Fix docs #181
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #181 +/- ##
=======================================
Coverage 75.08% 75.08%
=======================================
Files 31 31
Lines 1160 1160
=======================================
Hits 871 871
Misses 289 289 ☔ View full report in Codecov by Sentry. |
NelsonVides
approved these changes
Mar 4, 2024
| * **Syntax:** A string describing how this variable is used, can be extracted by APIs to document the behavior | ||
| * **Example:** `description = "a description of this variable"` | ||
| * **Example:** `"a description of this variable"` |
There was a problem hiding this comment.
Oh, this came from how it was done for MIM configuration modules, but here's not language agnostic, good catch! :D
| ```elixir | ||
| :amoc_dist.do(:my_scenario, 100, settings). | ||
| :amoc_dist.do(:my_scenario, 100, settings) |
There was a problem hiding this comment.
This is the main reason my elixir code doesn't compile, those accidental commas I'm so used to! 😅
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.
This PR fixes the minor issues (such as broken links, invalid code) that I found while reading the docs.