microsoft / microsoft/sql-server-samples
Mismatch of timeout unit in doc and example code
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 11.2k
- Forks
- 9.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 14
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?
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.
Thanks
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- cpp, sql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100