MicrosoftDocs / feedback

📢 docs.microsoft.com site feedback
https://learn.microsoft.com
Creative Commons Attribution 4.0 International
239 stars 160 forks source link

Many apis show arguments with TBD #543

Open shooshx opened 6 years ago

shooshx commented 6 years ago

Describe the bug Just a few I noticed today: https://docs.microsoft.com/en-us/windows/desktop/api/winuser/nf-winuser-drawtextexa https://docs.microsoft.com/en-us/windows/desktop/api/wingdi/nf-wingdi-getstockobject https://docs.microsoft.com/en-us/windows/desktop/api/wingdi/nf-wingdi-exttextouta

To Reproduce Steps to reproduce the behavior:

  1. Go to the above addresses

Expected behavior arguments would be documented as they always were

Powerhelmsman commented 6 years ago

@ginami Please take a look at this issue.

Derpalus commented 6 years ago

I noticed this earlier here: https://github.com/MicrosoftDocs/feedback/issues/493 Still not fixed one month later.

shooshx commented 6 years ago

TBD: fix TBDs

ginami commented 6 years ago

Hi @shooshx -- the TBDs in the pages you listed in your initial comment have been fixed. Thank you for bringing this issue to our attention.

shooshx commented 6 years ago

@ginami The TBD issue seem to be gone in these specific pages but here are a few APIs that still have problems in their argument description in the form of strange OPTIONAL placeholder:

https://docs.microsoft.com/en-us/windows/desktop/api/clfsw32/nf-clfsw32-reserveandappendlog https://docs.microsoft.com/en-us/windows/desktop/api/ktmw32/nf-ktmw32-createtransactionmanager https://docs.microsoft.com/en-us/windows/desktop/api/dsgetdc/nf-dsgetdc-dsderegisterdnshostrecordsw https://docs.microsoft.com/en-us/windows/desktop/api/winhttp/nf-winhttp-winhttpopenrequest

Here are some that still have TBD: https://docs.microsoft.com/en-us/windows/desktop/api/wininet/nf-wininet-internetsetoptionexw https://docs.microsoft.com/en-us/windows/desktop/api/winineti/nf-winineti-internetsetdialstatew https://docs.microsoft.com/en-us/windows/desktop/api/advpub/nf-advpub-extractfilesw https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-lookupaccountsidlocalw https://docs.microsoft.com/en-us/windows/desktop/api/workspaceruntime/nf-workspaceruntime-iworkspacescriptable3-startworkspaceex2

Are we having fun? I think this is fun. What wizardry is this you ask? oh, it's called Google, you should try it too:

https://www.google.co.il/search?q=TBD+site:https://docs.microsoft.com/en-us/windows/desktop/api/&safe=off&ei=Cq99W77iH5K6aeL_prAC&start=10&sa=N&biw=1767&bih=892

Otherwise, we can just continue to do this the same way, you fix 4 pages, then I find 4 more, etc', I'm good with that as well.

ginami commented 6 years ago

Thanks @shooshx -- yep, this is an ongoing migration issue and will continue to be on our radar until all are fixed.

shooshx commented 6 years ago

This ongoing migration issue sounds more like a python script that needs better error checking. You already had someone fixing it, couldn't they do the minimum verification that the output doesn't include the string "TBD"? You have people working on understanding human speech, parsing an xml correctly is too big of a deal? There are people relying on these pages for their daily work.