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

pythonlib: revert some doc changes #4042

Closed
wants to merge 2 commits into from

Conversation

jodersky
Copy link
Member

@jodersky jodersky commented Nov 28, 2024

This undoes my last commit of #3998, thereby re-establishing the ExampleCrossModulePython. It is required to get some sensible docs for the basic/ 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 in ExampleCrossModulePython to get the basic/ 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.

@jodersky jodersky requested a review from lihaoyi November 28, 2024 11:19
@jodersky
Copy link
Member Author

@himanshumahajan138

@himanshumahajan138
Copy link
Contributor

@jodersky to be honest when first time i wrote the docs for python examples i didn't used the snippets and upstream inheritances but @lihaoyi pointed out at that time that we should have something like exampleCrossModuleJava so after looking at kotlin example i got that idea of creating exampleCrossModulePython which extends the upstream java examples and java extends upstream scala examples.

I think @lihaoyi can sought out this...

@lihaoyi
Copy link
Member

lihaoyi commented Nov 28, 2024

@jodersky @himanshumahajan138 let's go without the example doc sharing for now for Python and leave it separate. We can merge them later if necessary

@himanshumahajan138
Copy link
Contributor

@jodersky @himanshumahajan138 let's go without the example doc sharing for now for Python and leave it separate. We can merge them later if necessary

Ok that's great 💯

@lihaoyi
Copy link
Member

lihaoyi commented Nov 29, 2024

We can probably close this then

@lihaoyi lihaoyi closed this Nov 29, 2024
@jodersky jodersky added the pythonlib Issues related to Mill's python support label Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pythonlib Issues related to Mill's python support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants