Skip to content

Conversation

@code-creator
Copy link
Owner

I have tried to improve documentation:

  • warn terminating null not written when used for string mapping and source string size does not include terminating null
  • remove comment of sort key being null terminated, as documentation already states it can contain embedded nulls at any position
  • describe how to compare sort keys
  • better describe the return values
  • better emphasis when return values are character count/byte counts

I'm not English speaker so please correct any mistakes I made.
The documentation for this function is really complicated, and one could consider to completely separate the documentation for using it for string mapping vs. using it for sort key generation ;-)

damabe added 30 commits March 12, 2021 01:28
…stwchar_int_emftype_constwchar).md for work item 1823825.
…ream_int_emftype_constwchar).md for work item 1823825.
…int_emftype_constwchar).md for work item 1823825.
cxwtool and others added 29 commits March 15, 2021 11:04
NERR_ServerNotStarted was missing.

Also adds the decimal representation of the errors.
First draft of RegRenameKey
Document additional NetServerGetInfo error code
Updated nf-mfidl-mfcreateavimediasink.md
Updated nf-mfidl-mfcreateavimediasink.md
…return_type_get_provider_properties

Corrected return values
Existing text said that if the subkey is NULL, then "the key gets a default security descriptor," which is incorrect. If the subkey is NULL, then we don't change the key security.

Explained what happens if the subkey is non-NULL: It is created as a non-volatile key with default security.
…kmark not found

[User Story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825) : Content Update: Ripple 3 validation cleanup for sdk-api.

Fixing build validation warnings for the following:
- Bookmark not found
- Insecure link
- Invalid note section
- Local file path
…alid ms-date

[User Story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825): Content Update: Ripple 3 validation cleanup for sdk-api.

Fix build validation warnings for invalid ms-date metadata values. ms.date must be a date in the format MM/DD/YYYY.
…eNotFound

[User Story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825): Content Update: Ripple 3 validation cleanup for sdk-api.

Fix build validation warnings for:
- MergeConflict (1 out of 1)
- MultipleH1s (3 out of 3)
- FileNotFound (41 out of 341)
…eNotFound 2

[User Story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825) : Content Update: Ripple 3 validation cleanup for sdk-api.

Fix more build validation warnings for:

- FileNotFound
…eNotFound 3

[User Story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825) : Content Update: Ripple 3 validation cleanup for sdk-api.

Fix more build validation warnings for:

- FileNotFound
…eNotFound 4

[User Story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825) : Content Update: Ripple 3 validation cleanup for sdk-api.

Fix more build validation warnings for:

- FileNotFound
…eNotFound 5

[User Story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825) : Content Update: Ripple 3 validation cleanup for sdk-api.

Fix more build validation warnings for:

- FileNotFound
Added PROPSHEET* notes pointing to new articles
…dented Code Blocks

Anyone notified by GitHub: this is for [user story 1823825](https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1823825) . I've got about 200 articles to review and will submit around 20 articles in each PR.

Addresses indented code blocks.

We are fixing issues related to Accessibility, SEO, and code blocks. You are welcome to review this PR, but for these changes, you don't need to sign off.

This is a bulk update.

Thanks -
- Renamed variadic arguments to "..."
- Renamed parameters from 'ArgN' to 'unnamedParamN' except 32-bit or 64-bit arguments and original ArgN parameters in header.

Related Work Item:
https://dev.azure.com/ceapex/Engineering/_workitems/edit/377933
- Better description of return values, by differing case string mapping and sort key generation
- Delete sort key zero terminator description, as doc already states it can have embedded zeros
- Advise destination string zero terminator only written if source char count includes it
- refined some comments
- added how to compare sort keys, please verify if this is correct
Corrected comparing sort keys.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.