Address commit comments (commit `6d7317a`)

[stdlib-bot]

This commit has 5 comment(s) from core contributors that require attention.

Commit: 6d7317af46884dca86c9775ca98d5c275d5fe05a

Comments:

• 6d7317a#r153449891

  Line 131: @stdlib-bot We don't align descriptions like this in Markdown documentation.

  stdlib/lib/node_modules/@stdlib/math/base/special/sincosd/README.md

  Lines 128 to 134 in 6d7317a

  	The function accepts the following arguments:
  	- **x**: `[in] double` input value.
  	- **sine**: `[out] double*` destination for the sine.
  	- **cosine**: `[out] double*` destination for the cosine.

• 6d7317a#r153449914

  Line 110: @stdlib-bot This should be sine ).

  stdlib/lib/node_modules/@stdlib/math/base/special/sincosd/benchmark/c/native/benchmark.c

  Lines 107 to 113 in 6d7317a

  	}
  	}
  	elapsed = tic() - t;
  	if ( cosine != cosine || sine != sine) {
  	printf( "unexpected results\n" );
  	}
  	return elapsed;

• 6d7317a#r153449916

  Line 104: @stdlib-bot This should be sine ).

  stdlib/lib/node_modules/@stdlib/math/base/special/sincosd/benchmark/c/native/benchmark.c

  Lines 101 to 107 in 6d7317a

  	for ( i = 0; i < ITERATIONS; i++ ) {
  	x = ( 20.0 * rand_double() ) - 10.0;
  	stdlib_base_sincosd( x, &sine, &cosine );
  	if ( cosine != cosine || sine != sine) {
  	printf( "unexpected results\n" );
  	break;
  	}

• 6d7317a#r153449948

  Line 70: @stdlib-bot This type definition can be improved to retain the type specificity of the output array. E.g., instead of collection, use NumericArray and then

  assign<T extends NumericArray>( x: number, out: T, stride: number, offset: number ): T;
  

  While this limits T to numeric arrays, that is the most likely scenario. We can always make more generic in the future.

  stdlib/lib/node_modules/@stdlib/math/base/special/sincosd/docs/types/index.d.ts

  Lines 67 to 73 in 6d7317a

  	* var bool = ( v === out );
  	* // returns true
  	*/
  	assign<T = unknown>( x: number, out: Collection<T>, stride: number, offset: number ): Collection<T | number>;
  	}
  	/**

• 6d7317a#r153449969

  Line 52: @stdlib-bot If the type definition is updated, this should also be updated to number[].

  stdlib/lib/node_modules/@stdlib/math/base/special/sincosd/docs/types/test.ts

  Lines 49 to 55 in 6d7317a

  	{
  	const out = [ 0.0, 0.0 ];
  	sincosd.assign( 3.14e-319, out, 1, 0 ); // $ExpectType Collection<number>
  	}
  	// The compiler throws an error if the `assign` method is provided a first argument which is not a number...

Interested in helping improve the project? If you are, the comment linked to above has 5 comment(s) from core contributors that could use your attention.

What do you need to do?

1. Open the above linked comments mentioning @stdlib-bot.
2. Review the suggested changes or follow-up tasks (e.g., formatting improvements, small refactorings, or clean-up).
3. If you are a first-time contributor, follow the contributing and development guides to setup your local environment for contributing to stdlib. If you are already a seasoned stdlib contributor, create a new branch on your local fork for making the changes.
4. Make all the desired changes and commit those changes to a local branch.
5. Push the changes to GitHub and open a new pull request against the develop branch of the main stdlib development repository.

Once you've opened a pull request, a stdlib maintainer will review your work and suggest any follow-up changes.

And that's it!

Thank you for your help in reducing the project backlog and in improving the quality of stdlib. 🙌

---

Notes

• For older commits, there is a chance that comments will have been already been addressed due to other refactorings. If you find that to be true, don't worry! Just move on to addressing the next comment, and, when opening your pull request and describing your proposed changes, be sure to link to the comment and mention that it has been addressed. This will help reviewers when reviewing your code!

---

This issue was created automatically to address commit comments tagging @stdlib-bot.

[stdlib-bot]

👋 Important: PLEASE READ 👋

This issue has been labeled as a good first issue and is available for anyone to work on.

If this is your first time contributing to an open source project, some aspects of the development process may seem unusual, arcane, or some combination of both.

1. You cannot "claim" issues. People new to open source often want to "claim" or be assigned an issue before beginning work. The typical rationale is that people want to avoid wasted work in the event that someone else ends up working the issue. However, this practice is not effective in open source, as it often leads to "issue squatting", in which an individual asks to be assigned, is granted their request, and then never ends up working on the issue. Accordingly, you are encouraged to communicate your intent to address this issue, ideally by providing a rough outline as to how you plan to address the issue or asking clarifying questions, but, at the end of the day, we will take running code and rough consensus in order to move forward quickly.
2. We have a very high bar for contributions. We have very high standards for contributions and expect all contributions—whether new features, tests, or documentation—to be rigorous, thorough, and complete. Once a pull request is merged into stdlib, that contribution immediately becomes the collective responsibility of all maintainers of stdlib. When we merge code into stdlib, we are saying that we, the maintainers, commit to reviewing subsequent changes and making bugfixes to the code. Hence, in order to ensure future maintainability, this naturally leads to a higher standard of contribution.

Before working on this issue and opening a pull request, please read the project's contributing guidelines. These guidelines and the associated development guide provide important information, including links to stdlib's Code of Conduct, license policy, and steps for setting up your local development environment.

To reiterate, we strongly encourage you to refer to our contributing guides before beginning work on this issue. Failure to follow our guidelines significantly decreases the likelihood that you'll successfully contribute to stdlib and may result in automatic closure of a pull request without review.

Setting up your local development environment is a critical first step, as doing so ensures that automated development processes for linting, license verification, and unit testing can run prior to authoring commits and pushing changes. If you would prefer to avoid manual setup, we provide pre-configured development containers for use locally or in GitHub Codespaces.

We place a high value on consistency throughout the stdlib codebase. We encourage you to closely examine other packages in stdlib and attempt to emulate the practices and conventions found therein.

• If you are attempting to contribute a new package, sometimes the best approach is to simply copy the contents of an existing package and then modify the minimum amount necessary to implement the feature (e.g., changing descriptions, parameter names, and implementation).
• If you are contributing tests, find a package implementing a similar feature and emulate the tests of that package.
• If you are updating documentation, examine several similar packages and emulate the content, style, and prose of those packages.

In short, the more effort you put in to ensure that your contribution looks and feels like stdlib—including variables names, bracket spacing, line breaks, etc—the more likely that your contribution will be reviewed and ultimately accepted. We encourage you to closely study the codebase before beginning work on this issue.

✨ Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions. ✨