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

[MAINT] Improve clarity, thumbnails, and fix mistakes in multivariate examples #194

Closed
wants to merge 5 commits into from

Conversation

tsbinns
Copy link
Collaborator

@tsbinns tsbinns commented May 30, 2024

Was double checking the documentation for mistakes when preparing the v0.7 release and noticed a few grammatical errors, spelling errors missed by codespell, and general poorly-worded parts of my examples.

There was also a very useful reference for the time-reversal in the Granger causality method which I forgot to include previously.

I also discovered the wonder of sphinx-gallery in-file config options and specified some nicer thumbnails for these examples.

@tsbinns
Copy link
Collaborator Author

tsbinns commented May 30, 2024

Not sure what is going on with the diff of the CaCoh example. Locally this shows only a few lines being changed, not the entire file being rewritten:
image

@drammock
Copy link
Member

Not sure what is going on with the diff of the CaCoh example

append ?w=1 to the URL and GitHub will ignore whitespace changes. Probably line endings are changing; did you make these edits on Windows (or change your git config setting for core.autocrlf)?

@tsbinns
Copy link
Collaborator Author

tsbinns commented May 30, 2024

append ?w=1 to the URL and GitHub will ignore whitespace changes. Probably line endings are changing; did you make these edits on Windows (or change your git config setting for core.autocrlf)?

Thanks for the suggestion! And yes, am using Windows.

@drammock
Copy link
Member

Thanks for the suggestion! And yes, am using Windows.

https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings

@tsbinns
Copy link
Collaborator Author

tsbinns commented May 30, 2024

Thanks @drammock. Followed the instructions so hopefully this doesn't happen again, although I don't see any normalised files for this branch...

@tsbinns tsbinns mentioned this pull request May 30, 2024
@drammock
Copy link
Member

although I don't see any normalised files for this branch...

you may need to make a trivial change to the CaCoh example, save, commit, and push again, for the line endings in the remote to get reset to unix-style

@tsbinns
Copy link
Collaborator Author

tsbinns commented May 30, 2024

you may need to make a trivial change to the CaCoh example, save, commit, and push again, for the line endings in the remote to get reset to unix-style

Unfortunately doesn't seem to be picked up.

Have just given it another go in #196 and there it works. Closing this.

@tsbinns tsbinns closed this May 30, 2024
@tsbinns tsbinns deleted the fix_mistakes_examples branch May 30, 2024 18:46
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