Mismatch of timeout unit in doc and example code

Open
#1,135 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, sql
Domain
documentation

Research direction

Compare the GetCommand declaration in the linked SQL Server VDI documentation with the timeout comment around lines 275-278 of samples/features/sqlvdi-linux/vdipipesample.cpp. Determine the authoritative time unit from the surrounding API or sample context, then make the documentation and example comment consistent; done means both references state the same unit.

Written by the indexing model from the issue text.

Description

I noticed there is a mismatch with the time unit of the timeout between sample code comment and doc, can someone from the team to confirm on the unit?

In the doc:
https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-backup-vdi-specification?view=sql-server-ver16#clientvirtualdevicegetcommand

int ClientVirtualDevice::GetCommand (
time_t	 	timeout,	// time-out in milliseconds
VDC_Command**	ppCmd	// returns the next command
);

However in the comment it said as seconds.

https://github.com/microsoft/sql-server-samples/blob/bccd6660ce5f5d881f5b8e3fbd66a2d8b7a88210/samples/features/sqlvdi-linux/vdipipesample.cpp#L275-L278

Thanks

Dominant language
PowerShell
Stars
11.2k
Forks
9.1k
Avg merge
2d 7h
Merged PRs (30d)
14

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/sql-server-samples

All issues in microsoft/sql-server-samples

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.