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

Docs: consistency for FQCN, spacing, etc #9232

Merged
merged 5 commits into from
Dec 13, 2021
Merged

Docs: consistency for FQCN, spacing, etc #9232

merged 5 commits into from
Dec 13, 2021

Conversation

andrew-demb
Copy link
Contributor

No description provided.

@andrew-demb
Copy link
Contributor Author

I found some more problems with a page about the second-level cache (https://www.doctrine-project.org/projects/doctrine-orm/en/2.10/reference/second-level-cache.html).
Probably not all of them I can fix because of a lack of knowledge about the RST format or how to find an alternative.

  1. broken description for list elements (cache factories - https://www.doctrine-project.org/projects/doctrine-orm/en/2.10/reference/second-level-cache.html#cache-factory). Compiled docs contain a separated list with elements (interface) and 'imploded' description for them without any delimiters.
  2. all references to API docs target to 404 page (example - https://www.doctrine-project.org/api/orm/current/Doctrine/ORM/Cache/Region.html)
  3. some places don't mention FQCN for referenced class or interface (within code snippets or inlined). Should we add FQCN for some of them? Example - https://www.doctrine-project.org/projects/doctrine-orm/en/2.10/reference/second-level-cache.html#cache-mode)
  4. there is one link with an anchor to the same page, but in "compiled" docs it doesn't display proper label for it (example - https://www.doctrine-project.org/projects/doctrine-orm/en/2.10/reference/second-level-cache.html#entity-cache-definition)

@andrew-demb andrew-demb mentioned this pull request Dec 10, 2021
Merged
@SenseException
Copy link
Member

  1. all references to API docs target to 404 page

API Docs were removed at some point. This link can be removed too.

  1. Should we add FQCN for some of them?

If the code example is rather a running code than a descriptive code to display different approaches, the FQCN is welcome there.

@andrew-demb
Copy link
Contributor Author

all references to API docs target to 404 page
API Docs were removed at some point. This link can be removed too.

OK. Removed.

Should we add FQCN for some of them?
If the code example is rather a running code than a descriptive code to display different approaches, the FQCN is welcome there.

Added to code examples.
I think examples will be more clear for now.

@SenseException SenseException merged commit 02a4e40 into doctrine:2.10.x Dec 13, 2021
@SenseException
Copy link
Member

@andrew-demb Thank you for the improvements.

@andrew-demb andrew-demb deleted the patch-2 branch December 14, 2021 06:08
derrabus added a commit that referenced this pull request Dec 20, 2021
@derrabus @andrew-demb
@olsavmic @beberlei
Merge 2.10.x into 2.11.x (#9276)
95d434d 
* Docs: consistency for FQCN, spacing, etc (#9232)

* Docs: consistent spacing, consistent array-style, consistent FQCN, avoid double escaped slashes, avoid double quotes if not necessary

* Docs: use special note block instead of markdown-based style

* Docs: Quote FQCN in table with backticks to be compatible with all render engines

* Drop all mentions API doc - it is not available anymore

* Add missed FQCN for code snippets

* Revert "Fix SchemaValidator with abstract child class in discriminator map (#9096)" (#9262)

This reverts commit bbb68d0.

* [docs] Fix wording for attributes=>parameters. (#9265)

Co-authored-by: Andrii Dembitskyi <andrew.dembitskiy@gmail.com>
Co-authored-by: olsavmic <molsavsky1@gmail.com>
Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>
derrabus added a commit to derrabus/orm that referenced this pull request Dec 26, 2021
@derrabus
Merge branch '2.11.x' into 3.0.x
47f931c 
* 2.11.x:
  Enable UnusedUse sniff again (doctrine#9267)
  Whitelist composer plugins used by this repository (doctrine#9286)
  Fix XML export for `change-tracking-policy` (doctrine#9285)
  Allow symfony/cache 6 (doctrine#9283)
  Put actual value instead of index inside $originalEntityData. (doctrine#9244)
  Fix return types of cache interfaces (doctrine#9271)
  Better explain limitations of DQL "DELETE" (doctrine#9281)
  Fix docblocks on nullable EM properties (doctrine#9273)
  Docs: use canonical order for phpdoc tags, add missed semicolon (doctrine#9190)
  Make PrimaryReadReplicaConnection enforcement explicit (doctrine#9239)
  Regenerate Psalm baseline (doctrine#9272)
  Improve compatibility with Doctrine DBAL 4 (doctrine#9266)
  [docs] Fix wording for attributes=>parameters. (doctrine#9265)
  Support for nesting attributes with PHP 8.1 (doctrine#9241)
  Revert "Fix SchemaValidator with abstract child class in discriminator map (doctrine#9096)" (doctrine#9262)
  Docs: consistency for FQCN, spacing, etc (doctrine#9232)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@greg0ire greg0ire greg0ire left review comments

@derrabus derrabus derrabus approved these changes

@SenseException SenseException SenseException approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@andrew-demb @SenseException @greg0ire @derrabus