Skip to content

Commit f7b2ebb

Browse files
committed
add modified lint copilot instructions aloing with lint ignore file
1 parent c69487c commit f7b2ebb

File tree

2 files changed

+21
-13
lines changed

2 files changed

+21
-13
lines changed

.github/copilot-instructions.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Project Overview
44

5-
**Julia scientific computing project** using DrWatson for reproducibility. Implements mathematical foundations (algebra, geometry, trigonometry) with visualization, comprehensive testing, and cross-repository documentation deployment.
5+
**Julia basic maths project** using DrWatson for reproducibility. Implements mathematical foundations (algebra, geometry, trigonometry) with visualization, comprehensive testing, and cross-repository documentation deployment.
66

77
### Core Architecture
88

@@ -19,14 +19,15 @@
1919
All code uses `@reexport` pattern and exports both computational + plotting functions:
2020

2121
```julia
22-
# src/Math_Foundations.jl
22+
# Main module uses @reexport for clean interface
2323
using Reexport
2424
@reexport using Symbolics, Nemo, Plots, Latexify, LaTeXStrings, Dates, AMRVW, Polynomials
2525

26-
# Export computational functions (no plotting)
26+
# Comprehensive exports for all functions
27+
# Pure computational functions (no plotting dependencies)
2728
export calculate_parabola_roots_quadratic, calculate_parabola_roots_polynomial, calculate_parabola_roots_amrvw
2829

29-
# Export integrated plotting functions (computation + visualization)
30+
# Integrated plotting functions (computation + visualization)
3031
export plot_parabola_roots_quadratic, plot_hyperbola, plot_hyperbola_axes_direct
3132

3233
# Always export new functions in main module
@@ -186,14 +187,14 @@ CI=true julia --project=. test/runtests.jl
186187
julia --project=. docs/make.jl
187188
```
188189

189-
### Julia Compilation
190-
191-
**CRITICAL**: First runs take 15-30 seconds for precompilation - DO NOT cancel early!
192-
193-
- **First Run**: `Precompiling DrWatson... 3 dependencies successfully precompiled in 17 seconds`
194-
- **Subsequent Runs**: Near-instant once cache exists
195-
- **Applies to**: ALL Julia commands including tests
196-
190+
## Julia Compilation Considerations
191+
- **Be Patient with First Runs**: Julia often needs to precompile packages and rebuild project cache on first run. when running a Julia command in the CLI for the first time, it may take a while to precompile the packages and build the project cache, so you won't see the results of running the command for a while.
192+
- **Typical First Run**: May take 15-30 seconds for precompilation before tests actually start
193+
- **Example Expected Output**: `Precompiling DrWatson... 3 dependencies successfully precompiled in 17 seconds`
194+
- **Subsequent Runs**: Much faster once cache is built
195+
- **Don't Cancel Early**: Allow time for compilation phase to complete
196+
- **IMPORTANT**: This applies to ALL Julia commands including CI testing with `CI=true julia --project=. test/runtests.jl`
197+
-
197198
### CI/CD Pipeline
198199

199200
- **Tests**: Run on all PRs (`.github/workflows/CI.yml`)
@@ -325,7 +326,9 @@ Documentation in `docs/src/` explains general math concepts (not code). Follow t
325326
- LaTeX syntax for symbols: `^\circ` not `°`, `\frac{}{}` for fractions
326327
- Label variables clearly: "where: $r$ = radius, $θ$ = angle"
327328
- Use aligned equations: `\begin{aligned}...\end{aligned}` for multi-step derivations
328-
- Use square brackets `[x, y]` for point coordinates consistently across documentation
329+
- **Square brackets in LaTeX math**: Use `\lbrack` and `\rbrack` instead of `[` and `]` inside math expressions to avoid markdown link interpretation errors
330+
- ✅ **CORRECT**: `$\mathbf{v} = \lbrack v_1, v_2 \rbrack$`
331+
- ❌ **WRONG**: `$\mathbf{v} = [v_1, v_2]$` (markdown interprets `[v_1, v_2]` as a link)
329332
330333
**MathWorld Links:**
331334
- Link every new mathematical term on first mention

.markdownlint-cli2.jsonc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"ignores": [
3+
".github/copilot-instructions.md"
4+
]
5+
}

0 commit comments

Comments
 (0)