europeana / rd-europeana-python-api

Python API for Europeana
European Union Public License 1.2
6 stars 2 forks source link

feedback: issues when transferring python notebook to rst files #67

Open paoloeuropeana opened 2 years ago

paoloeuropeana commented 2 years ago

When transferring the notebook to rst files a very common issue is that the a coding block in rst starts with "ipython3". This gives a warning that is not clear. The way to solve it is to replace "ipython3" with "python". Maybe this could be mentioned in the guidelines as possible issue. An actionable piece of advice about the rst files is to say in the contributing guidelines to compare the rst file of the new tutorial with the already existing and good ones, to get ideas on how correct possible mistakes.