zdm/event-bus
3
Fork 0
Code Issues 2 Pull Requests Releases 8 Wiki Activity

Document Latest Features in README #27

Merged
kske merged 6 commits from f/improved-readme into develop 2021-11-26 13:54:58 +01:00
Conversation 2 Commits 6 Files Changed 3 +48 -25
kske commented 2021-11-24 10:50:09 +01:00
Owner
Copy Link

Additionally, rename EventBus#printExecutionOrder(Class) to debugExecutionOrder for clarity, as it doesn't actually print anything.

Additionally, rename `EventBus#printExecutionOrder(Class)` to `debugExecutionOrder` for clarity, as it doesn't actually print anything.
kske self-assigned this 2021-11-24 10:50:09 +01:00
kske added 3 commits 2021-11-24 10:50:09 +01:00
Add debugging section to README ad29a93ccb
Add callback listener section to README d1c4bcc7eb
Move installation section up in README 3fccb809c8
kske requested review from delvh 2021-11-24 10:50:24 +01:00
delvh requested changes 2021-11-25 11:26:05 +01:00
README.md Outdated
@@ -57,0 +78,4 @@
If you intend to use event handlers that are inaccessible to Event Bus by means of Java language access control, make sure to allow reflective access from your module:
```java
opens my.module to dev.kske.eventbus.core;
delvh commented 2021-11-25 11:20:23 +01:00
Owner
Copy Link

opens works for modules as well?
I thought it should have been opens my.package to dev.kske.eventbus.core...

`opens` works for modules as well? I thought it should have been `opens my.package to dev.kske.eventbus.core`...
kske commented 2021-11-25 12:08:23 +01:00
Author
Owner
Copy Link

This seems to be wrong actually. I will change it accordingly.

This seems to be wrong actually. I will change it accordingly.
kske marked this conversation as resolved
README.md Outdated
@@ -178,3 +205,3 @@
```java
requires dev.kske.eventbus.core;
System.out.println(EventBus.getInstance().printExecutionOrder(SimpleEvent.class));
delvh commented 2021-11-25 11:25:28 +01:00
Owner
Copy Link

Something looks strange here:
a) if printXY prints directly, the syso part is unneeded.
b) if printXY only returns the result, then the function should be renamed.

Something looks strange here: a) if `printXY` prints directly, the `syso` part is unneeded. b) if `printXY` only returns the result, then the function should be renamed.
kske commented 2021-11-25 12:07:48 +01:00
Author
Owner
Copy Link

The code itself is correct, but I agree that the name of the method can be misleading. What would you call a method that formats the execution order in a human-readable way as a string, but doesn't print it. Printing it to sysout directly seemed to specific to me, as some applications would prefer using a logger instead.

The code itself is correct, but I agree that the name of the method can be misleading. What would you call a method that formats the execution order in a human-readable way as a string, but doesn't print it. Printing it to sysout directly seemed to specific to me, as some applications would prefer using a logger instead.
delvh commented 2021-11-25 12:21:44 +01:00
Owner
Copy Link

generateExecutionOrder?
getDebugInformation?
createExecutionOrderString?
executionOrderAsString?
getExecutionOrderAsString?

`generateExecutionOrder`? `getDebugInformation`? `createExecutionOrderString`? `executionOrderAsString`? `getExecutionOrderAsString`?
kske marked this conversation as resolved
kske added 1 commit 2021-11-25 14:29:12 +01:00
Fix module-info instructions in README 39ffb5c82a 
Reflective access has to be allowed from the Event Bus core package to a
package in the user's project, not the entire module. Thank you @delvh
for noticing this!
kske added 1 commit 2021-11-25 14:34:18 +01:00
Rename EventBus#printExecutionOrder(Class) to debugExecutionOrder 5a6d8bcf35 
The method doesn't print anything, but rather returns a string
containing the debug information.
kske added 1 commit 2021-11-25 14:36:13 +01:00
Merge branch 'develop' into f/improved-readme f620f06208 
Conflicts:
	event-bus-core/src/test/java/dev/kske/eventbus/core/DispatchTest.java
kske requested review from delvh 2021-11-25 14:36:53 +01:00
delvh approved these changes 2021-11-26 13:21:39 +01:00
kske merged commit 11860d1469 into develop 2021-11-26 13:54:58 +01:00
kske deleted branch f/improved-readme 2021-11-26 13:54:58 +01:00
Sign in to join this conversation.
Reviewers
No Reviewers
delvh
Labels
Clear labels
1
1
13
13
2
2
21
21
3
3
34
34
5
5
55
55
8
8
bug
Something isn't working
core
Event Bus Core
could have
This doesn't hurt
duplicate
This issue or pull request already exists
enhancement
New feature or request
help wanted
Extra attention is needed
must have
This is absolutely necessary
proc
Event Bus Proc
question
Further information is needed
should have
This should be implemented
wont have
This won't be implemented (for now)
L
Branches where 300 < X <= 600 lines are added and more than one work day is needed
M
Branches where 100 < X <=300 lines are added
S
Branches where X <= 100 lines are added or less than 30 minutes are needed
XL
Branch where X > 600 lines are added and more than two work days are needed
bug
Something is not working
bugfix
Fixes a bug
discussion
This has to be discussed
documentation
Related to documentation
feature
Introduces a new feature
maintenance
Related to project maintenance
postponed
Won't be done in the immediate future
refactoring
Refactoring code or architectures
wontfix
Will not be fixed in this state of development
No Label
Milestone
No items
No Milestone
Assignees
Clear assignees
delvh kske mpk
No Assignees kske
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: zdm/event-bus#27
No description provided.
Delete Branch "f/improved-readme"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?