Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixing documents #3073

Merged
merged 1 commit into from
Feb 16, 2021
Merged

fixing documents #3073

merged 1 commit into from
Feb 16, 2021

Conversation

c-chaitanya
Copy link
Contributor

No description provided.

@c-chaitanya c-chaitanya mentioned this pull request Feb 16, 2021
@nicolaskruchten
Copy link
Contributor

Thanks very much for this big sweep! I'll merge this and it should hit our site in 10-20 minutes :)

@nicolaskruchten nicolaskruchten merged commit bb4a47c into plotly:doc-prod Feb 16, 2021
@nicolaskruchten
Copy link
Contributor

@c-chaitanya how hard would it be to run this process on the function docstrings? It would be nice to batch-fix issues like #3074 if possible rather than doing them one at a time ;)

@jmonticolo
Copy link
Contributor

jmonticolo commented Feb 16, 2021

not only docstrings, but functions arguments too like this one : num_of_defualt_colors.

@nicolaskruchten
Copy link
Contributor

🙈 yikes, that's awkward :) well, that's been in our public API for so long I'm not sure it would be all that helpful to change it now but maybe we can do it in the v5 bump

@c-chaitanya
Copy link
Contributor Author

c-chaitanya commented Feb 16, 2021

Hi @nicolaskruchten
I have also tried this approach for the docstring part of python scripts. The issue I faced was that there were several entries(over 5000) in my output file, and all of them were from the tox folder. I wasn't sure if files in tox needed to be corrected. So I just left them. (Maybe my file iteration logic might be wrong have to check)

But to answer the question, yes this script should in theory work on any text corpus. I'll try to fix and run the code over this weekend.

This was referenced Feb 18, 2021
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.

3 participants