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

Improve DefaultDict doc #431

Merged
merged 1 commit into from Aug 16, 2018
Merged

Improve DefaultDict doc #431

merged 1 commit into from Aug 16, 2018

Conversation

scls19fr
Copy link
Member

@scls19fr scls19fr commented Aug 13, 2018

with setup/repl macro

Closes #364
Helps #360
Replaces #365

with setup/repl macro
@scls19fr scls19fr changed the title Improve DefaultDict doc [WIP] Improve DefaultDict doc Aug 13, 2018
@scls19fr
Copy link
Member Author

This PR shouldn't be merged for now because Documenter.jl repl/setup macros seems to be buggy when using CRLF EOL.

After saving this default_dict.md file with LF as EOL, local build of doc is correctly rendered but using such EOL is not a correct workaround as all other files are using CRLF and git complains when adding it

warning: LF will be replaced by CRLF in docs/src/default_dict.md.
The file will have its original line endings in your working directory.

See JuliaDocs/Documenter.jl#790 and JuliaDocs/Documenter.jl#749

Waiting for @mortenpi / @fredrikekre (or others Documenter.jl contributors) to fix it

@codecov
Copy link

codecov bot commented Aug 13, 2018

Codecov Report

Merging #431 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #431   +/-   ##
=======================================
  Coverage   98.19%   98.19%           
=======================================
  Files          30       30           
  Lines        1659     1659           
=======================================
  Hits         1629     1629           
  Misses         30       30

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55a2fce...2620e15. Read the comment docs.

@kmsquire
Copy link
Member

Can you add a commit before this one, which changes all doc files to use LF instead of CRLF?

@scls19fr
Copy link
Member Author

Sorry @kmsquire but I don't understand why I should do that.

Under Windows, git is replacing automatically LF with CRLF
See https://stackoverflow.com/questions/1967370/git-replacing-lf-with-crlf

Do you know a command line to do it quickly?

@fredrikekre
Copy link
Member

Documenter v19.5 is released with the bugfix included so if that was the problem here you are good to go.

@scls19fr scls19fr changed the title [WIP] Improve DefaultDict doc Improve DefaultDict doc Aug 16, 2018
@scls19fr scls19fr merged commit 28c1d6d into master Aug 16, 2018
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

4 participants