pythonlib: revert some doc changes #4042
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This undoes my last commit of #3998, thereby re-establishing the
ExampleCrossModulePython
. It is required to get some sensible docs for thebasic/
usecase.However, I'm still not convinced we should share documentation source code between scalalib and pythonlib examples. While it may make sense to share code between JVM technologies, I think python is a completely different beast, and not all concepts translate 1-1. We can see this just with the amount of
find-replaces
there are inExampleCrossModulePython
to get thebasic/
example working, and yet the resulting docs still feels off in some places. Also, with so many replacements, the blast radius of scalalib docs becomes unknown: if one day someone makes an innocent change to docs in scalalib, that may have non-sensical results in the python docs.Preferably, I would like to drop the
ExampleCrossModulePython
and just copy-paste text when necessary, at least until we have a proven pattern of reuse.