Skip to content

[General] Release #418

@ocots

Description

@ocots

@JuliaRegistrator register

Release notes:

Release Notes v0.18.5

Release Date: 2026-03-09
Version: 0.18.5
Type: Maintenance Release


📋 Overview

This is a maintenance release that focuses on documentation improvements and code quality enhancements. The release fixes cross-reference syntax issues in docstrings across the entire codebase, ensuring better documentation rendering and link consistency.


🧹 Changes

Documentation Reference Fixes

  • Fixed cross-reference syntax in docstrings by removing unnecessary @ref macros
  • Updated references in src/Exceptions/types.jl for cleaner documentation links
  • Updated references in src/Descriptions/ module files for consistency
  • Updated references in extension files:
    • ext/TestRunner.jl
    • ext/DocumenterReference.jl
    • ext/CoveragePostprocessing.jl
  • Improved documentation rendering and link consistency across the codebase

Version Update

  • Bumped version to 0.18.5 for maintenance release

🔧 Technical Details

Files Modified

File Changes
src/Exceptions/types.jl Removed @ref from cross-references
src/Descriptions/catalog.jl Updated docstring references
src/Descriptions/complete.jl Updated docstring references
src/Descriptions/types.jl Updated docstring references
ext/TestRunner.jl Updated docstring references
ext/DocumenterReference.jl Updated docstring references
ext/CoveragePostprocessing.jl Updated docstring references
Project.toml Version bump to 0.18.5

Documentation Impact

The changes improve:

  • Link rendering in generated documentation
  • Cross-reference consistency across all modules
  • Documentation build reliability
  • Developer experience when browsing API docs

⚠️ Breaking Changes

None - This is a non-breaking maintenance release.

All public APIs remain unchanged. No migration is required.


🔄 Upgrade Instructions

For Users

No action required. This is a transparent maintenance release.

For Developers

If you're building documentation locally, you may notice improved link rendering and cross-reference behavior.

# Update to latest version
using Pkg
Pkg.update("CTBase")

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions