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

fix docs #229

Merged
merged 3 commits into from
Oct 23, 2023
Merged

fix docs #229

merged 3 commits into from
Oct 23, 2023

Conversation

hhaensel
Copy link
Member

Currently CI docs fails during build for different reasons:

  1. docstrings not present
  2. refs between external packages (Observables and Core) cannot be resolved.

To resolve 1), I have added some docstrings. The rest I have commented out from the @docs section
To resolve 2), I have commented out on and Core.NamedTuples

I am not sure whether there is some other way or whether this PR coolides with other docs activities of the GenieFramework.

@essenciary @PGimenez you should know better than me and could help perhaps.

@hhaensel hhaensel marked this pull request as ready for review October 17, 2023 13:55
@PGimenez PGimenez self-requested a review October 18, 2023 17:23
@PGimenez PGimenez self-assigned this Oct 18, 2023
@PGimenez
Copy link
Member

this is good, thanks @hhaensel. We're currently focusing on fully documenting the StippleUI components, so nothing is being added to the Stipple.jl API docs atm.

@PGimenez PGimenez merged commit 027cb7a into master Oct 23, 2023
20 checks passed
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