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

Rewrite basic docs, without ExampleCrossPythonModule #4054

Closed
jodersky opened this issue Nov 30, 2024 · 4 comments · Fixed by #4063
Closed

Rewrite basic docs, without ExampleCrossPythonModule #4054

jodersky opened this issue Nov 30, 2024 · 4 comments · Fixed by #4063
Labels
pythonlib Issues related to Mill's python support
Milestone

Comments

@jodersky
Copy link
Member

In light of the discussion here, #4042, we should re-write the example docs of pythonlib/basic, with a plain ExampleCrossModule

@jodersky jodersky added the pythonlib Issues related to Mill's python support label Nov 30, 2024
@jodersky
Copy link
Member Author

Would you mind taking a shot at this, @himanshumahajan138?

@himanshumahajan138
Copy link
Contributor

@jodersky ya for sure i will add docs

@himanshumahajan138
Copy link
Contributor

also should we make this inheritable(means we can inherit these docs later for other examples based on same pattern) or simple ??

@jodersky
Copy link
Member Author

I would suggest we keep it as simple as possible to start.

Python support is a brand new feature, and while of course we want to implement a fully functional user experience, we also need to acknowledge that the first version will be no where near as polished as the scala and java support mill currently has. All to say, there will most likely be refactoring work to be done, and we can look into how we can extract common doc behavior when that time comes. Before is probably premature

@lihaoyi lihaoyi closed this as completed in b7d4d87 Dec 3, 2024
@lefou lefou added this to the 0.12.4 milestone Dec 3, 2024
jodersky pushed a commit to jodersky/mill that referenced this issue Jan 14, 2025
…[Basic Example] (com-lihaoyi#4063)

# Pull Request 
Re-write Docs for First Class Python Support [Basic Example]
Fixes: com-lihaoyi#4054 

## Description
Rewrite Docs for Python `1-simple`, `2-custom-build-logic` and
`3-multi-module` Examples


## Related Issues
- Link to related issue com-lihaoyi#4054.

## Checklist
- [x] Updated Documentation

## Status
Updated & Require Review!!!
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 a pull request may close this issue.

3 participants