Skip to content

Align README documentation with actual implementation#23

Merged
oyve merged 2 commits intodevfrom
copilot/update-documentation-and-categories
Oct 27, 2025
Merged

Align README documentation with actual implementation#23
oyve merged 2 commits intodevfrom
copilot/update-documentation-and-categories

Conversation

Copy link
Contributor

Copilot AI commented Oct 27, 2025

The README had formulas in wrong categories and was missing documentation for 13 implemented functions.

Categorization Fixes

  • Moved Cloud Base Height from Altitude → Phenomena (implemented in phenomena/cloud.ts)
  • Moved Heat Index and Humidex from Scales → new Indices section (thermal comfort indices, not classification scales)

Added Missing Formula Documentation

Temperature (3)

  • Dry Bulb Temperature (estimateDryBulbTemperature)
  • Temperature Inversion Detection (isTemperatureInversion)
  • Temperature conversion functions

Humidity (1)

  • Absolute Humidity (absoluteHumidity, absoluteHumidityByRelativeHumidity)

Wind (1)

  • Wind Gust Factor (windGustFactor)

Phenomena (2)

  • Cloud Temperature (cloudTemperature)
  • Fog Trend Probability (fogTrendProbability)

Scales (3)

  • Beaufort Scale variants: by Wind Speed, by Pressure, by Pressure Ratio

Indices (3)

  • Heat Index, Humidex, UTCI Assessment Scale (consolidated in new section)

Structural Changes

  • Created dedicated "Indices" section for thermal comfort calculations
  • Updated table of contents to include Phenomena and Indices
  • Added Wikipedia reference links to all new entries
Original prompt

Review documentation up against formulas and functions, and update where necessary. Also see if any is put under the wrong category in the Readme file.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: oyve <16225018+oyve@users.noreply.github.com>
@oyve
Copy link
Owner

oyve commented Oct 27, 2025

@copilot see if there is new snow.ts under /phenomena and document it as well

Copilot AI changed the title [WIP] Update documentation for formulas and functions Align README documentation with actual implementation Oct 27, 2025
Copilot AI requested a review from oyve October 27, 2025 19:12
Copy link
Contributor Author

Copilot AI commented Oct 27, 2025

@copilot see if there is new snow.ts under /phenomena and document it as well

I checked the repository thoroughly and there is no snow.ts file in the /phenomena directory or anywhere else in the codebase.

Current files in src/phenomena/:

  • cloud.ts
  • diurnalRythm.ts
  • fog.ts

If you'd like me to document a snow.ts file once it's added, or if it exists in a different location, please let me know where to find it.

@oyve oyve marked this pull request as ready for review October 27, 2025 19:15
@oyve oyve merged commit 6954122 into dev Oct 27, 2025
7 checks passed
@oyve oyve deleted the copilot/update-documentation-and-categories branch October 27, 2025 19:16
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