Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extend deprecation notice #486

Open
wants to merge 1 commit into
base: 1.14.x
Choose a base branch
from
Open

Extend deprecation notice #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ which are a native replacement for annotations. As such, this library is
considered feature complete, and should receive exclusively bugfixes and
security fixes.

We do not recommend using this library in new projects and encourage authors
Copy link
Member

@malarzm malarzm Aug 14, 2023 •
edited

Choose a reason for hiding this comment

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

Let's add # Project deprecated or something like this at the top so there's something big screaming "don't use me" :)

Also maybe a link to our blogpost https://www.doctrine-project.org/2022/11/04/annotations-to-attributes.html like "This is how Doctrine handled migration" to help folks discover this?

of downstream libraries to offer support for attributes as an alternative to
Doctrine Annotations.

# Doctrine Annotations

[![Build Status](https://github.com/doctrine/annotations/workflows/Continuous%20Integration/badge.svg?label=build)](https://github.com/doctrine/persistence/actions)
Expand Down
6 changes: 5 additions & 1 deletion docs/en/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ which are a native replacement for annotations. As such, this library is
considered feature complete, and should receive exclusively bugfixes and
security fixes.

We do not recommend using this library in new projects and encourage authors
of downstream libraries to offer support for attributes as an alternative to
Doctrine Annotations.

Introduction
============

Expand Down Expand Up @@ -38,7 +42,7 @@ You can install the Annotation component with composer:

.. code-block::

  $ composer require doctrine/annotations
$ composer require doctrine/annotations

Create an annotation class
==========================
Expand Down