-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Dec 18, 2024
1 parent
197925a
commit f055634
Showing
73 changed files
with
2,290 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-18T22:32:50","documenter_version":"1.8.0"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Contributing guidelines · Unfold.jl Timeseries Analysis & Deconvolution</title><meta name="title" content="Contributing guidelines · Unfold.jl Timeseries Analysis & Deconvolution"/><meta property="og:title" content="Contributing guidelines · Unfold.jl Timeseries Analysis & Deconvolution"/><meta property="twitter:title" content="Contributing guidelines · Unfold.jl Timeseries Analysis & Deconvolution"/><meta name="description" content="Documentation for Unfold.jl Timeseries Analysis & Deconvolution."/><meta property="og:description" content="Documentation for Unfold.jl Timeseries Analysis & Deconvolution."/><meta property="twitter:description" content="Documentation for Unfold.jl Timeseries Analysis & Deconvolution."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Unfold.jl Timeseries Analysis & Deconvolution</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Unfold Documentation</a></li><li><a class="tocitem" href="../installation/">Installing Julia + Unfold.jl</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../tutorials/lm_mu/">Mass univariate LM</a></li><li><a class="tocitem" href="../tutorials/lm_overlap/">LM overlap correction</a></li><li><a class="tocitem" href="../tutorials/lmm_mu/">Mass univariate Mixed Model</a></li><li><a class="tocitem" href="../tutorials/lmm_overlap/">LMM + overlap correction</a></li></ul></li><li><span class="tocitem">HowTo</span><ul><li><a class="tocitem" href="../HowTo/multiple_events/">Multiple events</a></li><li><a class="tocitem" href="../generated/HowTo/contrasts/">Change contrasts / coding schema</a></li><li><a class="tocitem" href="../HowTo/standarderrors/">Standard errors</a></li><li><a class="tocitem" href="../generated/HowTo/effects/">Marginal effects (must read re: splines)</a></li><li><a class="tocitem" href="../HowTo/custom_solvers/">Alternative Solvers (Robust, GPU, B2B)</a></li><li><a class="tocitem" href="../HowTo/lmm_pvalues/">P-values for mixedModels</a></li><li><a class="tocitem" href="../generated/HowTo/unfold_io/">Save and load Unfold models</a></li><li><a class="tocitem" href="../HowTo/pymne/">🐍 Import EEG with PyMNE.jl</a></li><li><a class="tocitem" href="../generated/HowTo/juliacall_unfold/">🐍 Calling Unfold.jl directly from Python</a></li></ul></li><li><span class="tocitem">Explanations</span><ul><li><a class="tocitem" href="../generated/explanations/nonlinear_effects/">Non-Linear effects</a></li><li><a class="tocitem" href="../explanations/basisfunctions/">Basisfunctions</a></li><li><a class="tocitem" href="../generated/explanations/predict/">Predictions</a></li><li><a class="tocitem" href="../generated/explanations/window_length/">Window Length Effect</a></li></ul></li><li><span class="tocitem">Reference</span><ul><li><a class="tocitem" href="../references/extensions/">Overview of package extensions</a></li><li><a class="tocitem" href="../generated/references/solver/">Solver/optimizer implementations</a></li><li><a class="tocitem" href="../references/benchmarks/">Solver benchmarks</a></li><li><a class="tocitem" href="../references/types/">API: Types</a></li><li><a class="tocitem" href="../references/functions/">API: Functions</a></li></ul></li><li><span class="tocitem">Contributing</span><ul><li class="is-active"><a class="tocitem" href>Contributing guidelines</a><ul class="internal"><li><a class="tocitem" href="#Bug-reports-and-discussions"><span>Bug reports and discussions</span></a></li><li><a class="tocitem" href="#Working-on-an-issue"><span>Working on an issue</span></a></li></ul></li></ul></li><li><span class="tocitem">Developer Guide</span><ul><li><a class="tocitem" href="../91-developer/">Developer documentation</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Contributing</a></li><li class="is-active"><a href>Contributing guidelines</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Contributing guidelines</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/unfoldtoolbox/Unfold.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/unfoldtoolbox/Unfold.jl/blob/main/docs/src/90-contributing.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="contributing"><a class="docs-heading-anchor" href="#contributing">Contributing guidelines</a><a id="contributing-1"></a><a class="docs-heading-anchor-permalink" href="#contributing" title="Permalink"></a></h1><p>First of all, thanks for the interest!</p><p>We welcome all kinds of contribution, including, but not limited to code, documentation, examples, configuration, issue creating, etc.</p><p>Be polite and respectful, and follow the code of conduct.</p><h2 id="Bug-reports-and-discussions"><a class="docs-heading-anchor" href="#Bug-reports-and-discussions">Bug reports and discussions</a><a id="Bug-reports-and-discussions-1"></a><a class="docs-heading-anchor-permalink" href="#Bug-reports-and-discussions" title="Permalink"></a></h2><p>If you think you found a bug, feel free to open an <a href="https://github.com/unfoldtoolbox/Unfold.jl/issues">issue</a>. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.</p><h2 id="Working-on-an-issue"><a class="docs-heading-anchor" href="#Working-on-an-issue">Working on an issue</a><a id="Working-on-an-issue-1"></a><a class="docs-heading-anchor-permalink" href="#Working-on-an-issue" title="Permalink"></a></h2><p>If you found an issue that interests you, comment on that issue what your plans are. If the solution to the issue is clear, you can immediately create a pull request (see below). Otherwise, say what your proposed solution is and wait for a discussion around it.</p><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><p>Feel free to ping us after a few days if there are no responses.</p></div></div><p>If your solution involves code (or something that requires running the package locally), check the <a href="../91-developer/">developer documentation</a>. Otherwise, you can use the GitHub interface directly to create your pull request.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../references/functions/">« API: Functions</a><a class="docs-footer-nextpage" href="../91-developer/">Developer documentation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 18 December 2024 22:32">Wednesday 18 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.