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

Updating Documentation across IPUMS.jl #31

Draft
wants to merge 44 commits into
base: main
Choose a base branch
from

Conversation

MichelaRocchetti
Copy link
Contributor

Adding new page contents to documentation

Copy link

codecov bot commented Jun 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 23.92%. Comparing base (12e8c49) to head (b0f2372).
Report is 17 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##            main      #31       +/-   ##
==========================================
+ Coverage   1.19%   23.92%   +22.73%     
==========================================
  Files         25       27        +2     
  Lines        420      606      +186     
==========================================
+ Hits           5      145      +140     
- Misses       415      461       +46     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

MichelaRocchetti and others added 24 commits June 14, 2024 17:15
- added code example
- adjusted variable descriptions
- added code example
- add variable descriptions
- added references
- add Examples
-add description
-add References
-add Returns
-add description
-add examples
- add return
add description
add return
add ref
add examples
add description
add example
add reference
add return
add description
add reference
add examples
add arguments
add refernce
add description
add arguments add examples
add ref 
add description
add arguments
add examples
add description add reference add examples add return
add descruption add reference add examples add return add description
add returns 
add examples
add ref
add description
add description,examples,ref,return. To be checked
added code example to DataExtract.
added reference to ChatGPT.
@TheCedarPrince TheCedarPrince changed the title deploying Documenter.jl to IPUMS.jl Updating Documentation across IPUMS.jl Jul 3, 2024
Copy link
Member

@TheCedarPrince TheCedarPrince left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @MichelaRocchetti ,

This is looking really really superb! This is very well done and is beginning to look exactly like what I know @00krishna and I were looking for. I left several comments because many files are very close to being ready to be done. Thanks for all the hard work and let me know if you have any questions!

Additionally, one extra thing you should do as you review these comments is to also run LiveServer to preview your documentation. I noticed some visual errors that I tried to catch but be sure to review the documentation as it would appear live. I may have missed some.

Thanks!

docs/make.jl Outdated Show resolved Hide resolved
docs/src/index_michela.md Outdated Show resolved Hide resolved
src/models/model_DataExtract.jl Outdated Show resolved Hide resolved
src/models/model_DataExtract.jl Outdated Show resolved Hide resolved
src/models/model_DataExtractDefinition.jl Outdated Show resolved Hide resolved
src/models/model_Error.jl Outdated Show resolved Hide resolved
src/models/model_Shapefile.jl Outdated Show resolved Hide resolved
src/models/model_TimeSeriesTableFull.jl Outdated Show resolved Hide resolved
src/models/model_TimeSeriesTableFullTimeSeriesInner.jl Outdated Show resolved Hide resolved
src/models/model_TimeSeriesTableSimple.jl Outdated Show resolved Hide resolved
- change definition
-suppress output
-keyword argument
examples in argument
fixed description and return 
missing example
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.

None yet

3 participants