Skip to content

Fix links (second round)#1143

Merged
Datseris merged 6 commits into
JuliaDynamics:mainfrom
jmaspons:fix_links2
Mar 11, 2025
Merged

Fix links (second round)#1143
Datseris merged 6 commits into
JuliaDynamics:mainfrom
jmaspons:fix_links2

Conversation

@jmaspons
Copy link
Copy Markdown
Contributor

@jmaspons jmaspons commented Mar 3, 2025

Partially fix #1142

Don't know how to fix:

 89:6664: gent &lt;: AbstractAgent</code></pre><p>The minimal agent struct for usage with <a href="@ref OSM.OpenStreetMapSpace"><code>OpenStreetMapSpace</code></a>. It has an additional field <code>pos::
 95:697: , as an agent can truly be at any possible point on an existing road.</p><p>Use <a href="@ref OSM.OSMAgent"><code>OSMAgent</code></a> for convenience.</p><p><strong>Obtaining map files</strong>
131:4193: his map requires <code>network_type = :none</code> to be passed as a keyword to <a href="@ref OSM.OpenStreetMapSpace"><code>OpenStreetMapSpace</code></a>. The unit of distance used for this map

Not sure about the missing docstring for isempty and the resulting broken link:
125:1191: position</code></a>, but specialized for <code>GridSpaceSingle</code>. See also <a href="@ref"><code>isempty</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.04%. Comparing base (8b5b456) to head (7617aa1).
Report is 177 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1143       +/-   ##
===========================================
+ Coverage   70.12%   85.04%   +14.91%     
===========================================
  Files          42       37        -5     
  Lines        2718     2534      -184     
===========================================
+ Hits         1906     2155      +249     
+ Misses        812      379      -433     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jmaspons
Copy link
Copy Markdown
Contributor Author

jmaspons commented Mar 3, 2025

Pending warnings:
┌ Warning: Cannot resolve @ref for md"[OpenStreetMapSpace](@ref OSM.OpenStreetMapSpace)" in src/api.md.
│ - No docstring found in doc for binding Agents.OSM.OpenStreetMapSpace.

┌ Warning: Cannot resolve @ref for md"[OSMAgent](@ref OSM.OSMAgent)" in src/api.md.
│ - No docstring found in doc for binding Agents.OSM.OSMAgent.

┌ Warning: Cannot resolve @ref for md"OpenStreetMapSpace" in src/api.md.
│ - No docstring found in doc for binding Agents.OSM.OpenStreetMapSpace.
│ - Fallback resolution in Main for OpenStreetMapSpace -> Agents.OpenStreetMapSpace is only allowed for fully qualified names

┌ Warning: Cannot resolve @ref for md"[OpenStreetMapSpace](@ref OSM.OpenStreetMapSpace)" in src/api.md.
│ - No docstring found in doc for binding Agents.OSM.OpenStreetMapSpace.

Copy link
Copy Markdown
Contributor Author

@jmaspons jmaspons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread docs/src/api.md
Comment thread docs/src/api.md
Copy link
Copy Markdown
Member

@Datseris Datseris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say since we dont know how to fix the remaining failures, we might as well merge this? Can you please go to Project.toml and bump the patch version?

@jmaspons
Copy link
Copy Markdown
Contributor Author

Ok, I'll leave the patch in a state that doesn't throw errors and we can merge. I'll also add some clarification about GraphSpace inheriting from DiscrecteSpace.

@jmaspons
Copy link
Copy Markdown
Contributor Author

Ready to merge, @Datseris

@Datseris
Copy link
Copy Markdown
Member

Thanks a lot again!!!

@Datseris Datseris merged commit 8cc8883 into JuliaDynamics:main Mar 11, 2025
@jmaspons jmaspons deleted the fix_links2 branch March 11, 2025 15:36
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.

Broken links in docs (round 2)

3 participants