Scribe-Data icon indicating copy to clipboard operation
Scribe-Data copied to clipboard

Add bash command for updating Unicode data to docs

Open andrewtavis opened this issue 1 year ago • 3 comments

Terms

Issue

As of now readthedocs:scribe_data/unicode/update_unicode_data.html doesn't have a code block example for its usage like readthedocs:scribe_data/translation/update_words_to_translate.html. This issue would add a code block to the first page that adds the command for the file docstring:

python3 src/scribe_data/unicode/update_unicode_data.py

andrewtavis avatar Oct 03 '24 08:10 andrewtavis

@mhmohona, I made this issue, but we should discuss how we actually want this commands to work in the future as the user is going to be potentially downloading from pip, so we'll then not have this path as we've had till now 🤔 Maybe some kind of way to pick up the location of the package?

andrewtavis avatar Oct 03 '24 08:10 andrewtavis

hey @andrewtavis , can i kindly work on this?

masembebrian avatar Oct 08 '24 05:10 masembebrian

Ye sure, thanks @masembebrian!

andrewtavis avatar Oct 08 '24 06:10 andrewtavis

Unassigning so others can pick this up. Let us know if you still have interest, @masembebrian :)

andrewtavis avatar Oct 22 '24 23:10 andrewtavis

Hi @andrewtavis, as per our earlier discussion, I removed all the translation files which I think has also broken this example link here https://scribe-data.readthedocs.io/en/latest/scribe_data/translation/update_words_to_translate.html . Can you help me find another example link?

KesharwaniArpita avatar Oct 23 '24 08:10 KesharwaniArpita

Closing this as this page already has an example that's viable given the doc string.

andrewtavis avatar Oct 24 '24 14:10 andrewtavis