search

scribe-org / Scribe-Data

Wikidata, Wiktionary and Wikipedia language data extraction
GNU General Public License v3.0
30 stars 69 forks source link

Standardize function doc strings across Scribe-Data #56

Closed andrewtavis closed 8 months ago

andrewtavis commented 1 year ago

Terms

Description

As of now we're using two different styles of doc strings for functions in Scribe-Data. This issue would be to standardize them such that we have a consistent style of documentation throughout the codebase.

Contribution

Happy to support with this! I'm about to make another issue for creating readthedocs documentation. That issue should be worked on in combination with this one such that we can first check which style of doc string is preferable based on how it's rendered, and then we can make the changes to standardize them :) :)

andrewtavis commented 1 year ago

CC @m-charlton :) Making the issue for readthedocs now 🙃

Jk40git commented 9 months ago

@andrewtavis I would like to be assigned for this issue.

andrewtavis commented 9 months ago

Makes sense, @Jk40git! I'll try to get to the reviews soon :)

Jk40git commented 9 months ago

Makes sense, @Jk40git! I'll try to get to the reviews soon :)

all right will be glad

andrewtavis commented 8 months ago

Closed via #63 and #64 :) Thanks @Jk40git! Appreciate the help 😊

Jk40git commented 8 months ago

Closed via #63 and #64 :) Thanks @Jk40git! Appreciate the help 😊

You are welcome