Ver código fonte

Improved the clarity of the top-level API doc (#2984)

I clarified some of the language here so that it is easier for the beginner to understand. (It was a little bit awkward before)
John Gorenfeld 6 anos atrás
pai
commit
c89559634b
1 arquivos alterados com 3 adições e 2 exclusões
  1. 3
    2
      docs/docs/top-level-api.md

+ 3
- 2
docs/docs/top-level-api.md Ver arquivo

@@ -1,6 +1,7 @@
1 1
 # Top Level API
2 2
 
3
-In order to make navigation API homogenous as much as possible, we provide setRoot function that receives layout of any kind.
3
+So as to make the navigation API as consistent and homogenous as possible, we begin with a single, unifying function -- setRoot -- that receives properties for any kind of layout, whether tabs or stacks.
4
+
4 5
 See [Layout types](docs/layout-types)
5 6
 
6 7
 
@@ -96,4 +97,4 @@ Navigation.registerScreen('example.AdvancedScreen', () => AdvancedScreen);
96 97
 
97 98
 In some cases you might need the id of the currently visible screen. This method returns the unique id of the currently visible screen:
98 99
 `const visibleScreenInstanceId = await Navigation.getCurrentlyVisibleScreenId()`
99
-In order to have any use of this method, you'd need to map instanceId to screens your self. -->
100
+In order to have any use of this method, you'd need to map instanceId to screens your self. -->