search

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.
MIT License
4.38k stars 2.71k forks source link

For Reference docs - Fix content issues found in azure-docs-sdk-python pipeline #33909

Open KatGreenSmith opened 6 months ago

KatGreenSmith commented 6 months ago

Hello @danieljurek , please let me know if you have any questions - link to the Ref ADO bug info: https://dev.azure.com/ceapex/Engineering/_workitems/edit/928878

Describe the bug Some docstring errors in azure-ai-ml package caused warnings in our pipeline. Reaching out to make you aware to fix.

For options in literalinclude directive, the option content should be indented. The directive won't work because Sphinx can't parse it, and the code they want to include won't show on our page (although it doesn't break our new pipeline). b8558959-c544-48ab-a650-13093b3ebb0a

f9a89460-db78-4177-97ad-5838eba11348

Jun Shi has created an example pr: Fix azure-ai-ml docstring error of literalinclude directive indent by junshi356 · Pull Request #33629 · Azure/azure-sdk-for-python (github.com)

To Reproduce n/a

Expected behavior

Screenshots

Additional context

github-actions[bot] commented 5 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Azure/azure-ml-sdk @azureml-github.

kristapratico commented 5 months ago

@azureml-github can you please take a look at this issue and review the related PR? https://github.com/Azure/azure-sdk-for-python/pull/33629

diondrapeck commented 5 months ago

@kristapratico - Will do