Docs modification for better clarification #424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## 0.0.1-alpha #424 +/- ##
=================================================
- Coverage 98.573% 98.523% -0.051%
=================================================
Files 29 29
Lines 3646 3657 +11
=================================================
+ Hits 3594 3603 +9
- Misses 52 54 +2
|
czgdp1807
added
documentation
czgdp1807
reviewed
Oct 27, 2021
Comment on lines
62
to
63
| " the two methods." %(source)) | ||
| elif not hasattr(self, target): |
There was a problem hiding this comment.
Suggested change
| " the two methods." %(source)) | |
| elif not hasattr(self, target): | |
| " the two methods." %(source)) | |
| if not hasattr(self, target): |
czgdp1807
reviewed
Oct 27, 2021
| " vertices on its own. This is done to maintain" | ||
| " clear separation between the functionality of" | ||
| " the two methods." %(target)) | ||
| else: |
czgdp1807
reviewed
Oct 27, 2021
Comment on lines
56
to
62
| raise ValueError("Vertex %s is not present in the graph." | ||
| " Call Graph.add_vertex() to add a new" | ||
| " vertex. Graph.add_edge is only responsible" | ||
| " for adding edges and it will not add new" | ||
| " vertices on its own. This is done to maintain" | ||
| " clear separation between the functionality of" | ||
| " the two methods." %(source)) |
There was a problem hiding this comment.
I think this whole string can be represented as msg = ("Vertex %s is not present in the graph." " Call Graph.add_vertex() to add a new" " vertex. Graph.add_edge is only responsible" " for adding edges and it will not add new" " vertices on its own. This is done to maintain" " clear separation between the functionality of" " the two methods.")
And then just do msg%(source). I am not sure if it's syntactically correct. But what I am trying to say is the both the messages only differ in the name of the vertex (source, target) rest of the stuff is same. So using a variable will be helpful to avoid repetition.
czgdp1807
reviewed
Oct 27, 2021
pydatastructs/graphs/graph.py
Outdated
Comment on lines
53
to
59
| Note | ||
| ==== | ||
| Steps to create a graph: | ||
| 1. Create nodes (AdjacencyListGraphNode or AdjacencyListMatrixNode) | ||
| 2. Add nodes to the graph | ||
| 3. Add edges b/w these nodes | ||
|
|
There was a problem hiding this comment.
Suggested change
| Note | |
| ==== | |
| Steps to create a graph: | |
| 1. Create nodes (AdjacencyListGraphNode or AdjacencyListMatrixNode) | |
| 2. Add nodes to the graph | |
| 3. Add edges b/w these nodes | |
| Note | |
| ==== | |
| Steps to create a graph: | |
| 1. Create nodes (AdjacencyListGraphNode or AdjacencyListMatrixNode). | |
| 2. Add nodes to the graph. | |
| 3. Add edges between these nodes. | |
czgdp1807
added a commit
that referenced
this pull request
Nov 14, 2021
* Changed version to 0.0.1-alpha * pydatastructs -> pydatastructs_ for PyPI * pydatasturcts_ -> cz-pydatastructs * Removed incorrect topic * Updated installation instructions on website * Minor typo fix in documentation * Doc improvements (ODA, DODA) and addition of checks in ``graph`` (#424) * Made the API of ``RangeQueryStatic`` consistent (#425) * Added notebook for California road network (#426) * Added salient features of PyDataStructs (#428) * Bumped to 0.0.1-beta * Bumped to 0.0.1 * Updated for master Co-authored-by: Pratik Goyal <pratikgoyal2712@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modified Docs to resolve discrepancies
References to other Issues or PRs or Relevant literature
Fixes #406
Fixes #423
Brief description of what is fixed or changed
Other comments