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

Add model reference docu #61

Merged
merged 12 commits into from
Nov 27, 2024
Merged

Conversation

behrica
Copy link
Member

@behrica behrica commented Nov 23, 2024

content wise I am done.
I migrated the existing "reference" documentation of models from smile , xgboost and sklearn-clj

I am not sure, if my layout changes are fine for all screen sizes, see in clay.edn.
For sure, the so far default was far too small for my new content

@behrica behrica requested a review from daslu November 23, 2024 23:31
@behrica
Copy link
Member Author

behrica commented Nov 26, 2024

to me I am done.
I marked the new chapters as draft

@daslu
Copy link
Member

daslu commented Nov 26, 2024

@behrica

Great.

I cannot read so carefully now, so I'd recommend merging this as a draft, as we discussed.

One thing that seems important to me is not to hide the namespace definitions, so that the tutorials will be self-contained.

@behrica
Copy link
Member Author

behrica commented Nov 27, 2024

I will rebase it now.

@behrica
Copy link
Member Author

behrica commented Nov 27, 2024

One thing that seems important to me is not to hide the namespace definitions, so that the tutorials will be self-contained.
What do you mean ?
I did hide now the ns declarations,
but this does not make it self contained (not even sure what you mean by this)

This makes it "visualy nicer" to look at, but not more then that.

@daslu
Copy link
Member

daslu commented Nov 27, 2024

Thanks.
The reason I think it is better 🌟 not 🌟 to hide the namespace definitions is that the namespace definitions allow the person reading the tutorial to know what the namespace aliases mean: mm, ml, tc-mm, etc.
By this, I mean self-contained: knowing what everything means.

@behrica behrica force-pushed the addModelReferenceDocu branch from 99bdb29 to f189885 Compare November 27, 2024 15:04
@behrica
Copy link
Member Author

behrica commented Nov 27, 2024

Its true, I will have a look.
some of the reference ns have "no example", so there we should see no code at all.
But some have indeed

@behrica
Copy link
Member Author

behrica commented Nov 27, 2024

I will merge, when done

@behrica behrica merged commit 2ddf0cc into scicloj:main Nov 27, 2024
3 checks passed
@behrica behrica deleted the addModelReferenceDocu branch November 27, 2024 16:21
@daslu
Copy link
Member

daslu commented Nov 27, 2024

Thanks

@behrica
Copy link
Member Author

behrica commented Nov 27, 2024

The "draft" is in the "chapter", bu not in the TOC
not sure why

@behrica
Copy link
Member Author

behrica commented Nov 27, 2024

now it is..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants