Skip to content

Commit aad7c86

Browse files
committed
chore: Prepare release 1.0.0
1 parent 962d631 commit aad7c86

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CHANGELOG.md

+60
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,66 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

77
<!-- insertion marker -->
8+
## [1.0.0](https://github.com/mkdocstrings/griffe/releases/tag/1.0.0) - 2024-08-15
9+
10+
<small>[Compare with 0.49.0](https://github.com/mkdocstrings/griffe/compare/0.49.0...1.0.0)</small>
11+
12+
**V1!** :rocket: :fire: :rainbow:
13+
14+
### Breaking changes
15+
16+
Highlights:
17+
18+
- Extensions inherit from `Extension`, (`VisitorExtension` and `InspectorExtension` are removed)
19+
- Members are serialized (`as_dict`/JSON) as a dictionary instead of a list
20+
- All objects are available in the top-level `griffe` module, nowhere else
21+
22+
Removed objects:
23+
24+
- all modules under the `griffe` package
25+
- the `griffe.DocstringWarningCallable` class
26+
- the `griffe.When` class
27+
- the `griffe.ExtensionType` type
28+
- the `griffe.InspectorExtension` class
29+
- the `griffe.VisitorExtension` class
30+
- the `griffe.HybridExtension` extension
31+
- the `griffe.patch_logger` function
32+
- the `griffe.JSONEncoder.docstring_parser` attribute
33+
- the `griffe.JSONEncoder.docstring_options` attribute
34+
- the `griffe.Extensions.attach_visitor` method
35+
- the `griffe.Extensions.attach_inspector` method
36+
- the `griffe.Extensions.before_visit` method
37+
- the `griffe.Extensions.before_children_visit` method
38+
- the `griffe.Extensions.after_children_visit` method
39+
- the `griffe.Extensions.after_visit` method
40+
- the `griffe.Extensions.before_inspection` method
41+
- the `griffe.Extensions.before_children_inspection` method
42+
- the `griffe.Extensions.after_children_inspection` method
43+
- the `griffe.Extensions.after_inspection` method
44+
- the `griffe.GriffeLoader.load_module` method
45+
- the `has_special_name` and `has_private_name` properties on objects
46+
- the `is_explicitely_exported` and `is_implicitely_exported` properties on objects
47+
- the `member_is_exported` method on objects
48+
49+
50+
Renamed/moved objects:
51+
52+
- `griffe.Function.setter` -> `griffe.Attribute.setter`
53+
- `griffe.Function.deleter` -> `griffe.Attribute.deleter`
54+
55+
Signatures:
56+
57+
- `griffe.docstring_warning(name)` parameter was removed
58+
- `griffe.GriffeLoader.load(module)` parameter was removed
59+
- `griffe.load(module)` parameter was removed
60+
- `griffe.load_git(module)` parameter was removed
61+
- `griffe.find_breaking_changes(ignore_private)` parameter was removed
62+
- see previous deprecations
63+
64+
### Code Refactoring
65+
66+
- Remove all legacy code for v1 ([86d321e](https://github.com/mkdocstrings/griffe/commit/86d321ed1303f7bde28950f14ea75412be1d6888) and [fd72083](https://github.com/mkdocstrings/griffe/commit/fd72083fa06c3eb4ef76fe74c5126eef308766c0)by Timothée Mazzucotelli). [PR-314](https://github.com/mkdocstrings/griffe/pull/314)
67+
868
## [0.49.0](https://github.com/mkdocstrings/griffe/releases/tag/0.49.0) - 2024-08-14
969

1070
<small>[Compare with 0.48.0](https://github.com/mkdocstrings/griffe/compare/0.48.0...0.49.0)</small>

0 commit comments

Comments
 (0)