Skip to content

Commit 629dfd8

Browse files
committed
docs: update devcontainer setup
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 3bf0e7d commit 629dfd8

File tree

2 files changed

+42
-14
lines changed

2 files changed

+42
-14
lines changed

docs/dev_faqs.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,32 @@ You can suppress that warning by adding a `// cppcheck-suppress uninitvar` comme
160160
stdlib_strided_dmeanvarpn( len, 1, x, 1, out, 1 );
161161
```
162162
163+
<a name="decimals">
164+
165+
## When to use decimals while writing examples, benchmarks and documentation and when should I avoid it?
166+
167+
Decimals are our way of showing that the number that we're trying to denote is a floating point value in C. Note that all numbers in JavaScript are treated as a floating point value. for example:
168+
169+
while trying to call this function
170+
171+
```c
172+
double stdlib_strided_dnanvariancetk( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX );
173+
```
174+
175+
in javascript or in C, we expect you to write
176+
177+
```javascript
178+
var dnanvariancetk = require( '@stdlib/stats/base/dnanvariancetk' );
179+
var Float64Array = require( '@stdlib/array/float64' );
180+
181+
var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
182+
183+
var v = dnanvariancetk( 4, 1.0, x, 1 );
184+
// returns ~4.33333
185+
```
186+
187+
notice how we used `1.0` in the second arguement because it is a double precision floating point number, while we didn't use it in the first and fourth arguements as they are integers
188+
163189
<a name="compilation-error"></a>
164190

165191
## I have the required packages in the expected paths, but I am still encountering an error like this while compiling the native add-on.

docs/devcontainer_setup.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,27 @@ limitations under the License.
2020

2121
# Devcontainer Setup
2222

23-
> step by step tutorial on how to setup the repo in a devcontainer.
23+
> Step-by-Step Tutorial on How to Set Up the Repository in a Dev Container
2424
2525
## Introduction
2626

27-
We appreciate your interest in contributing to stdlib! Below, we've provided a step-by-step tutorial on how to set up the project locally on your device using a devcontainer.
27+
We appreciate your interest in contributing to stdlib! Below, we've provided a step-by-step tutorial on how to set up the project locally on your device using a dev container.
2828

29-
The stdlib repository includes a preconfigured devcontainer, making it the easiest way to set up your development environment. It ensures proper linting, EditorConfig, and tooling are configured right from the start.
29+
The stdlib repository includes a preconfigured dev container, making it the easiest way to set up your development environment. It ensures proper linting, EditorConfig, and tooling are configured right from the start.
3030

31-
### Prerequisites
32-
33-
setting up the stdlib devcontainer **requires** the following prerequisites:
31+
**Note:** The dev container does not yet support ARM64 architectures. For more information, or if you're interested in adding ARM64 support, you can visit this [issue][devcontainer-issue].
3432

33+
### Prerequisites
3534

36-
- [Git][git]: version control
37-
- [Docker][docker]: containerization
38-
- [VS Code][vscode]: preferred IDE
35+
Setting up the stdlib dev container **requires** the following prerequisites:
3936

37+
- [Git][git]: Version control
38+
- [Docker][docker]: Containerization
39+
- [VS Code][vscode]: Preferred IDE
4040

4141
### Download
4242

43-
To acquire the source code, first navigate to the parent directory into which you want to place the project [Git][git] repository
43+
To acquire the source code, first navigate to the parent directory where you want to place the project’s [Git][git] repository.
4444

4545
<!-- run-disable -->
4646

@@ -64,17 +64,17 @@ If you are wanting to contribute to stdlib, first [fork][github-fork] the reposi
6464
$ git clone https://github.com/<username>/stdlib.git
6565
```
6666

67-
Open the repo in VS Code.
67+
Open the repository in VS Code.
6868

6969
```bash
7070
$ cd stdlib && code .
7171
```
7272

73-
When prompted, Open the repo in the dev container.
73+
When prompted, open the repository in the dev container.
7474

7575
![image](https://github.com/user-attachments/assets/233c08d2-57ec-46c4-8e12-ecb3ca608f83)
7676

77-
Kindly be patient as the post create script may take some time to install all the required languages and dependencies.
77+
Please be patient, as the post-create script may take some time to install all the required languages and dependencies.
7878

7979
![image](https://github.com/user-attachments/assets/8cd011e8-ec41-4216-be1c-d10ce5824928)
8080

@@ -88,7 +88,7 @@ Close the terminal after the installation is completed.
8888

8989
![image](https://github.com/user-attachments/assets/267cd367-2eff-4d8b-8fb6-721cf5b066e2)
9090

91-
If you see this when you open the terminal then the devcontainer installation was successful!
91+
If you see this when you open the terminal, then the dev container installation was successful!
9292

9393
![image](https://github.com/user-attachments/assets/598259d3-7ce2-4e86-8147-78ba634701a7)
9494

@@ -100,6 +100,8 @@ If you see this when you open the terminal then the devcontainer installation wa
100100

101101
[vscode]: https://code.visualstudio.com/
102102

103+
[devcontainer-issue]: https://github.com/stdlib-js/stdlib/issues/4934
104+
103105
[github-fork]: https://help.github.com/articles/fork-a-repo/
104106

105107
</section>

0 commit comments

Comments
 (0)