laminas-servicemanager icon indicating copy to clipboard operation
laminas-servicemanager copied to clipboard

Published 20 hours ago • verified publisher icon laminas

Update reflection based abstract factory documentation

Open settermjd opened this issue 2 years ago • 12 comments

Q A
Documentation yes
Bugfix yes
BC Break no
New Feature no
RFC no
QA no

Description

After working through the documentation to learn more about the Reflection-based Abstract Factor, I felt that the documentation could be refined to make it that much easier to read and maintain, as well as to extend the usage examples to make them more encompassing of different use cases. This PR replaces https://github.com/laminas/laminas-servicemanager/pull/134.

settermjd avatar Jun 08 '22 08:06 settermjd

Note: IMO for 3.13.x

Ocramius avatar Jun 13 '22 16:06 Ocramius

Note: IMO for 3.13.x

I'm pretty sure @froschdesign recommended 3.11. @froschdesign?

settermjd avatar Jun 15 '22 13:06 settermjd

Unless it's a bugfix, it should be landing in new minors in general :D

Ocramius avatar Jun 15 '22 13:06 Ocramius

Note: IMO for 3.13.x

As already mentioned: with the current state of documentation, in terms of quality and quantity, any change can be considered as a patch. No matter if something is updated or added. I have no problem with a patch for the documentation being released as a minor version with other pull requests. But only a change to the documentation as a minor makes the release rather sad. Because nothing is changed on the user side after a Composer update.

froschdesign avatar Jun 15 '22 13:06 froschdesign

I'd do a patch release even for docs, which is just more noise tho? :thinking:

In this case, I'd do 2 releases + 2 merge-ups

Ocramius avatar Jun 15 '22 14:06 Ocramius

I'd do a patch release even for docs, which is just more noise tho?

It would be much better if changes to documentation did not require releases at all. :stuck_out_tongue_winking_eye:

froschdesign avatar Jun 15 '22 14:06 froschdesign

I don't mind, honestly - we don't have enough noise from it for it to be a problem.

Ocramius avatar Jun 15 '22 14:06 Ocramius

@Ocramius, if you don't mind either way, I'd prefer to leave it as is. On a different note, what can I do about the DCO check failing, as it relates to laminas bot? Bildschirmfoto vom 2022-06-17 12-51-36 ?

Just merge anyway?

settermjd avatar Jun 17 '22 10:06 settermjd

Yeah, DCO is useless corporateism, so it can be ignored on anything that isn't "world-changing tech", TBH.

Ocramius avatar Jun 17 '22 10:06 Ocramius

@froschdesign your call on where/how to merge/release

Ocramius avatar Jun 17 '22 10:06 Ocramius

@settermjd @froschdesign I've also modified the documentation in #180

Should we try to finish this as well and then merge-up to 4.0.x?

boesing avatar Apr 30 '23 08:04 boesing

@boesing

Should we try to finish this as well and then merge-up to 4.0.x?

A good idea, because the entire documentation needs to be reworked for version 4.0.

froschdesign avatar May 02 '23 06:05 froschdesign